<!DOCTYPE HTML>
<html lang="zh">
<head>
<title>Nginx 中文文档 - Module ngx_http_api_module | Docs4dev</title>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<meta name="description" content="Nginx (engine x) 是一个高性能的HTTP和反向代理服务，也是一个IMAP/POP3/SMTP服务。">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<meta property="og:type" content="website">
<meta property="og:title" content="Nginx 中文文档 - Module ngx_http_api_module">
<meta property="og:url" content="https://www.docs4dev.com/docs/zh/nginx/current/reference/http-ngx_http_api_module.html">
<meta property="og:site_name" content="Docs4dev">
<meta property="og:locale" content="zh_CN">
<meta name="twitter:card" content="Nginx (engine x) 是一个高性能的HTTP和反向代理服务，也是一个IMAP/POP3/SMTP服务。">
<meta name="generator" content="Docs4dev template engine">
<link rel="stylesheet" href="static/css/app.min.css">
<link rel="shortcut icon" href="https://www.docs4dev.com/static/images/favicon.ico" type="image/x-icon">
<script async="" src="static/js/js.js"></script>
<script async="" src="static/js/adsbygoogle.js" crossorigin="anonymous"></script>
<script>
    window.dataLayer = window.dataLayer || [];

    function gtag() {
      dataLayer.push(arguments);
    }

    gtag('js', new Date());
    gtag('config', 'UA-129571937-1');
  </script>
<link rel="amphtml" href="https://www.docs4dev.com/amp/docs/zh/nginx/current/reference/http-ngx_http_api_module.html">
<script type="application/ld+json">{"name":null,"headline":"Nginx 中文文档-Module ngx_http_api_module","inLanguage":"zh-CN","version":"current","image":"/static/icon/icon-nginx.svg","datePublished":"2021-05-20T12:51:01Z","dateCreated":"2021-05-20T12:51:01Z","dateModified":"2021-07-07T12:48:29Z","@context":"https://schema.org/","@type":"APIReference","abstract":"Nginx (engine x) 是一个高性能的HTTP和反向代理服务，也是一个IMAP/POP3/SMTP服务。"}</script>
</head>
<body>
<div class="book with-summary">
<div class="book-summary">
<div class="logo">
<a href="index.html" style="color: inherit;">
<img src="static/picture/icon-nginx.svg" style="width: 48px; height: 48px;" alt="Logo">
</a>
<b style="color: inherit; margin-left: 8px;">Nginx 中文文档</b>
</div>
<div class="item">
<div>
<label for="version">版本</label>
<select id="version" onchange="onVersionChange(this)">
<option value="current" selected="selected">current</option>
</select>
</div>
<div style="margin-top: 8px;">
<label for="language">语言</label>
<select id="language" onchange="onLangChange(this)" value="zh">
<option value="en">English</option>
<option value="zh" selected="selected">中文</option>
</select>
</div>

</div>
<div class="item menus">
<a title="Table of Contents" style="margin-right: 8px;" href="index.html">
<i class="fa fa-chevron-left"></i>
<span style="margin-left: 2px;">返回目录</span>
</a>
</div>
<nav role="navigation" id="navigation">
<ul class="summary">
<li class="chapter"> <a href="install.html" title="Introduction"> Introduction </a>
<ul class="articles">
<li class="chapter"> <a href="install.html" title="Installing nginx"> Installing nginx </a> </li>
<li class="chapter"> <a href="configure.html" title="从源代码构建  Nginx"> 从源代码构建 Nginx </a> </li>
<li class="chapter"> <a href="beginners_guide.html" title="Beginner's Guide"> Beginner's Guide </a> </li>
<li class="chapter"> <a href="control.html" title="Controlling nginx"> Controlling nginx </a> </li>
<li class="chapter"> <a href="events.html" title="连接处理方法"> 连接处理方法 </a> </li>
<li class="chapter"> <a href="hash.html" title="设置哈希"> 设置哈希 </a> </li>
<li class="chapter"> <a href="debugging_log.html" title="调试日志"> 调试日志 </a> </li>
<li class="chapter"> <a href="syslog.html" title="记录到系统日志"> 记录到系统日志 </a> </li>
<li class="chapter"> <a href="syntax.html" title="配置文件测量单位"> 配置文件测量单位 </a> </li>
<li class="chapter"> <a href="switches.html" title="Command-line parameters"> Command-line parameters </a> </li>
<li class="chapter"> <a href="windows.html" title="Windows 版  Nginx"> Windows 版 Nginx </a> </li>
<li class="chapter"> <a href="http-request_processing.html" title="Nginx 如何处理请求"> Nginx 如何处理请求 </a> </li>
<li class="chapter"> <a href="http-server_names.html" title="Server names"> Server names </a> </li>
<li class="chapter"> <a href="http-load_balancing.html" title="使用  Nginx 作为  HTTP 负载均衡器"> 使用 Nginx 作为 HTTP 负载均衡器 </a> </li>
<li class="chapter"> <a href="http-configuring_https_servers.html" title="配置  HTTPS 服务器"> 配置 HTTPS 服务器 </a> </li>
<li class="chapter"> <a href="stream-stream_processing.html" title="Nginx 如何处理  TCP/UDP 会话"> Nginx 如何处理 TCP/UDP 会话 </a> </li>
<li class="chapter"> <a href="njs-index.html" title="用  njs 编写脚本"> 用 njs 编写脚本 </a> </li>
</ul> </li>
<li class="chapter"> <a href="howto_build_on_win32.html" title="How-To"> How-To </a>
<ul class="articles">
<li class="chapter"> <a href="howto_build_on_win32.html" title="使用  Visual C 在  Win32 平台上构建  Nginx"> 使用 Visual C 在 Win32 平台上构建 Nginx </a> </li>
<li class="chapter"> <a href="nginx_dtrace_pid_provider.html" title="使用  DTrace pid 提供程序调试  nginx"> 使用 DTrace pid 提供程序调试 nginx </a> </li>
<li class="chapter"> <a href="http-converting_rewrite_rules.html" title="转换重写规则"> 转换重写规则 </a> </li>
<li class="chapter"> <a href="http-websocket.html" title="WebSocket proxying"> WebSocket proxying </a> </li>
</ul> </li>
<li class="chapter"> <a href="contributing_changes.html" title="Development"> Development </a>
<ul class="articles">
<li class="chapter"> <a href="contributing_changes.html" title="Contributing Changes"> Contributing Changes </a> </li>
<li class="chapter"> <a href="dev-development_guide.html" title="Development guide"> Development guide </a> </li>
</ul> </li>
<li class="chapter"> <a href="dirindex.html" title="Modules reference"> Modules reference </a>
<ul class="articles">
<li class="chapter"> <a href="dirindex.html" title="指令的字母索引"> 指令的字母索引 </a> </li>
<li class="chapter"> <a href="varindex.html" title="变量按字母顺序索引"> 变量按字母顺序索引 </a> </li>
<li class="chapter"> <a href="ngx_core_module.html" title="Core functionality"> Core functionality </a> </li>
<li class="chapter"> <a href="http-ngx_http_core_module.html" title="ngx_http_core_module"> ngx_http_core_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_access_module.html" title="ngx_http_access_module"> ngx_http_access_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_addition_module.html" title="ngx_http_addition_module"> ngx_http_addition_module </a> </li>
<li class="chapter"> <a href="" title="ngx_http_api_module"> ngx_http_api_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_auth_basic_module.html" title="ngx_http_auth_basic_module"> ngx_http_auth_basic_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_auth_jwt_module.html" title="ngx_http_auth_jwt_module"> ngx_http_auth_jwt_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_auth_request_module.html" title="ngx_http_auth_request_module"> ngx_http_auth_request_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_autoindex_module.html" title="ngx_http_autoindex_module"> ngx_http_autoindex_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_browser_module.html" title="ngx_http_browser_module"> ngx_http_browser_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_charset_module.html" title="ngx_http_charset_module"> ngx_http_charset_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_dav_module.html" title="ngx_http_dav_module"> ngx_http_dav_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_empty_gif_module.html" title="ngx_http_empty_gif_module"> ngx_http_empty_gif_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_f4f_module.html" title="ngx_http_f4f_module"> ngx_http_f4f_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_fastcgi_module.html" title="ngx_http_fastcgi_module"> ngx_http_fastcgi_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_flv_module.html" title="ngx_http_flv_module"> ngx_http_flv_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_geo_module.html" title="ngx_http_geo_module"> ngx_http_geo_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_geoip_module.html" title="ngx_http_geoip_module"> ngx_http_geoip_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_grpc_module.html" title="ngx_http_grpc_module"> ngx_http_grpc_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_gunzip_module.html" title="ngx_http_gunzip_module"> ngx_http_gunzip_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_gzip_module.html" title="ngx_http_gzip_module"> ngx_http_gzip_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_gzip_static_module.html" title="ngx_http_gzip_static_module"> ngx_http_gzip_static_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_headers_module.html" title="ngx_http_headers_module"> ngx_http_headers_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_hls_module.html" title="ngx_http_hls_module"> ngx_http_hls_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_image_filter_module.html" title="ngx_http_image_filter_module"> ngx_http_image_filter_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_index_module.html" title="ngx_http_index_module"> ngx_http_index_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_js_module.html" title="ngx_http_js_module"> ngx_http_js_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_keyval_module.html" title="ngx_http_keyval_module"> ngx_http_keyval_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_limit_conn_module.html" title="ngx_http_limit_conn_module"> ngx_http_limit_conn_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_limit_req_module.html" title="ngx_http_limit_req_module"> ngx_http_limit_req_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_log_module.html" title="ngx_http_log_module"> ngx_http_log_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_map_module.html" title="ngx_http_map_module"> ngx_http_map_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_memcached_module.html" title="ngx_http_memcached_module"> ngx_http_memcached_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_mirror_module.html" title="ngx_http_mirror_module"> ngx_http_mirror_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_mp4_module.html" title="ngx_http_mp4_module"> ngx_http_mp4_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_perl_module.html" title="ngx_http_perl_module"> ngx_http_perl_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_proxy_module.html" title="ngx_http_proxy_module"> ngx_http_proxy_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_random_index_module.html" title="ngx_http_random_index_module"> ngx_http_random_index_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_realip_module.html" title="ngx_http_realip_module"> ngx_http_realip_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_referer_module.html" title="ngx_http_referer_module"> ngx_http_referer_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_rewrite_module.html" title="ngx_http_rewrite_module"> ngx_http_rewrite_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_scgi_module.html" title="ngx_http_scgi_module"> ngx_http_scgi_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_secure_link_module.html" title="ngx_http_secure_link_module"> ngx_http_secure_link_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_session_log_module.html" title="ngx_http_session_log_module"> ngx_http_session_log_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_slice_module.html" title="ngx_http_slice_module"> ngx_http_slice_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_spdy_module.html" title="ngx_http_spdy_module"> ngx_http_spdy_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_split_clients_module.html" title="ngx_http_split_clients_module"> ngx_http_split_clients_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_ssi_module.html" title="ngx_http_ssi_module"> ngx_http_ssi_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_ssl_module.html" title="ngx_http_ssl_module"> ngx_http_ssl_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_status_module.html" title="ngx_http_status_module"> ngx_http_status_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_stub_status_module.html" title="ngx_http_stub_status_module"> ngx_http_stub_status_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_sub_module.html" title="ngx_http_sub_module"> ngx_http_sub_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_upstream_module.html" title="ngx_http_upstream_module"> ngx_http_upstream_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_upstream_conf_module.html" title="ngx_http_upstream_conf_module"> ngx_http_upstream_conf_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_upstream_hc_module.html" title="ngx_http_upstream_hc_module"> ngx_http_upstream_hc_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_userid_module.html" title="ngx_http_userid_module"> ngx_http_userid_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_uwsgi_module.html" title="ngx_http_uwsgi_module"> ngx_http_uwsgi_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_v2_module.html" title="ngx_http_v2_module"> ngx_http_v2_module </a> </li>
<li class="chapter"> <a href="http-ngx_http_xslt_module.html" title="ngx_http_xslt_module"> ngx_http_xslt_module </a> </li>
<li class="chapter"> <a href="mail-ngx_mail_core_module.html" title="ngx_mail_core_module"> ngx_mail_core_module </a> </li>
<li class="chapter"> <a href="mail-ngx_mail_auth_http_module.html" title="ngx_mail_auth_http_module"> ngx_mail_auth_http_module </a> </li>
<li class="chapter"> <a href="mail-ngx_mail_proxy_module.html" title="ngx_mail_proxy_module"> ngx_mail_proxy_module </a> </li>
<li class="chapter"> <a href="mail-ngx_mail_ssl_module.html" title="ngx_mail_ssl_module"> ngx_mail_ssl_module </a> </li>
<li class="chapter"> <a href="mail-ngx_mail_imap_module.html" title="ngx_mail_imap_module"> ngx_mail_imap_module </a> </li>
<li class="chapter"> <a href="mail-ngx_mail_pop3_module.html" title="ngx_mail_pop3_module"> ngx_mail_pop3_module </a> </li>
<li class="chapter"> <a href="mail-ngx_mail_smtp_module.html" title="ngx_mail_smtp_module"> ngx_mail_smtp_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_core_module.html" title="ngx_stream_core_module"> ngx_stream_core_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_access_module.html" title="ngx_stream_access_module"> ngx_stream_access_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_geo_module.html" title="ngx_stream_geo_module"> ngx_stream_geo_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_geoip_module.html" title="ngx_stream_geoip_module"> ngx_stream_geoip_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_js_module.html" title="ngx_stream_js_module"> ngx_stream_js_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_keyval_module.html" title="ngx_stream_keyval_module"> ngx_stream_keyval_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_limit_conn_module.html" title="ngx_stream_limit_conn_module"> ngx_stream_limit_conn_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_log_module.html" title="ngx_stream_log_module"> ngx_stream_log_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_map_module.html" title="ngx_stream_map_module"> ngx_stream_map_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_proxy_module.html" title="ngx_stream_proxy_module"> ngx_stream_proxy_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_realip_module.html" title="ngx_stream_realip_module"> ngx_stream_realip_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_return_module.html" title="ngx_stream_return_module"> ngx_stream_return_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_split_clients_module.html" title="ngx_stream_split_clients_module"> ngx_stream_split_clients_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_ssl_module.html" title="ngx_stream_ssl_module"> ngx_stream_ssl_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_ssl_preread_module.html" title="ngx_stream_ssl_preread_module"> ngx_stream_ssl_preread_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_upstream_module.html" title="ngx_stream_upstream_module"> ngx_stream_upstream_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_upstream_hc_module.html" title="ngx_stream_upstream_hc_module"> ngx_stream_upstream_hc_module </a> </li>
<li class="chapter"> <a href="stream-ngx_stream_zone_sync_module.html" title="ngx_stream_zone_sync_module"> ngx_stream_zone_sync_module </a> </li>
<li class="chapter"> <a href="ngx_google_perftools_module.html" title="ngx_google_perftools_module"> ngx_google_perftools_module </a> </li>
</ul> </li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<header class="book-header">
<div class="dropdown pull-right js-toolbar-action">
<a class="btn toggle-dropdown" aria-label="Language" href="#">
<i class="fa fa-globe"></i>
</a>
<div class="dropdown-menu dropdown-left">
<div class="dropdown-caret"><span class="caret-outer"></span><span class="caret-inner"></span></div>
<div class="buttons">
<button class="button size-1" onclick="changeLang('zh_CN')">中文</button>
</div>
<div class="buttons">
<button class="button size-1" onclick="changeLang('en_US')">English</button>
</div>
</div>
</div>
<a class="btn pull-right js-toolbar-action non-mobile" aria-label="Sign up" href="register.html">
<i class="fa fa-sign-in"></i> <span>注册</span>
</a>
 <a class="btn pull-right js-toolbar-action non-mobile" aria-label="Sign in" href="register.html">
<i class="fa fa-sign-in"></i>
<span>登录</span>
</a>
<a class="btn pull-left js-toolbar-action btn-summary" href="#"><i class="fa fa-align-justify"></i></a>
<div class="dropdown pull-left font-settings js-toolbar-action">
<a class="btn toggle-dropdown" aria-label="Font Settings" href="#">
<i class="fa fa-font"></i>
</a>
<div class="dropdown-menu dropdown-right">
<div class="dropdown-caret"><span class="caret-outer"></span><span class="caret-inner"></span></div>
<div class="buttons">
<button class="button size-2 font-reduce">A</button>
<button class="button size-2 font-enlarge">A</button>
</div>
<div class="buttons">
<button class="button size-2 family-serif">Serif</button>
<button class="button size-2 family-sans">Sans</button>
</div>
<div class="buttons">
<button class="button size-3 theme-white">White</button>
<button class="button size-3 theme-sepia">Sepia</button>
<button class="button size-3 theme-night">Night</button>
</div>
</div>
</div>
<a class="btn pull-left js-toolbar-action non-mobile" aria-label="Home" href="zh.html">
<i class="fa fa-home"></i> <span>首页</span>
</a>
<a class="btn pull-left js-toolbar-action non-mobile" aria-label="Guide" href="javascript:window.open('https://www.javadoc.org/');">
<i class="fa fa-book"></i> <span>API Docs</span>
</a>
<a class="btn pull-left js-toolbar-action non-mobile" aria-label="Tools" href="index1.html">
<i class="fa fa-gears"></i> <span>工具</span>
</a>
<div class="dropdown pull-left js-toolbar-action mobile">
<a class="btn toggle-dropdown" aria-label="Language" href="#">
<i class="fa fa-chevron-down"></i>
</a>
<div class="dropdown-menu dropdown-right">
<div class="dropdown-caret"><span class="caret-outer"></span><span class="caret-inner"></span></div>
<div class="buttons">
<a class="button size-1" aria-label="Home" href="zh.html">
<i class="fa fa-home"></i> <span>首页</span>
</a>
</div>
<div class="buttons">
<a class="button size-1" aria-label="Guide" href="javascript:window.open('https://www.javadoc.org/');">
<i class="fa fa-book"></i> <span>API Docs</span>
</a>
</div>
<div class="buttons">
<a class="button size-1" aria-label="Tools" href="index1.html">
<i class="fa fa-gears"></i> <span>工具</span>
</a>
</div>
</div>
</div>
<div id="autocomplete" class="pull-right"></div>
<span id="toolbar-title"></span>
</header>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<section class="normal markdown-section">
<div id="content">
<h1>Module ngx_http_api_module</h1>
<div><ins class="adsbygoogle" style="display:block; text-align:center;" data-ad-layout="in-article" data-ad-format="fluid" data-ad-client="ca-pub-6108808167664152" data-ad-slot="6964403648"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script></div>
<div><ul>
<li><a href="#example">Example Configuration</a></li>
<li><a href="#directives">Directives</a>
<ul>
<li><a href="#api">api</a></li>
<li><a href="#status_zone">status_zone</a></li>
</ul>
</li>
<li><a href="#compatibility">Compatibility</a></li>
<li><a href="#endpoints">Endpoints</a>
<ul>
<li><a href="#root">/</a></li>
<li><a href="#nginx">/nginx</a></li>
<li><a href="#processes">/processes</a></li>
<li><a href="#connections">/connections</a></li>
<li><a href="#slabs_">/slabs/</a></li>
<li><a href="#slabs_slab_zone_name">/slabs/{slabZoneName}</a></li>
<li><a href="#http_">/http/</a></li>
<li><a href="#http_requests">/http/requests</a></li>
<li><a href="#http_server_zones_">/http/server_zones/</a></li>
<li><a href="#http_server_zones_http_server_zone_name">/http/server_zones/{httpServerZoneName}</a></li>
<li><a href="#http_location_zones_">/http/location_zones/</a></li>
<li><a href="#http_location_zones_http_location_zone_name">/http/location_zones/{httpLocationZoneName}</a></li>
<li><a href="#http_caches_">/http/caches/</a></li>
<li><a href="#http_caches_http_cache_zone_name">/http/caches/{httpCacheZoneName}</a></li>
<li><a href="#http_limit_conns_">/http/limit_conns/</a></li>
<li><a href="#http_limit_conns_http_limit_conn_zone_name">/http/limit_conns/{httpLimitConnZoneName}</a></li>
<li><a href="#http_limit_reqs_">/http/limit_reqs/</a></li>
<li><a href="#http_limit_reqs_http_limit_req_zone_name">/http/limit_reqs/{httpLimitReqZoneName}</a></li>
<li><a href="#http_upstreams_">/http/upstreams/</a></li>
<li><a href="#http_upstreams_http_upstream_name_">/http/upstreams/{httpUpstreamName}/</a></li>
<li><a href="#http_upstreams_http_upstream_name_servers_">/http/upstreams/{httpUpstreamName}/servers/</a></li>
<li><a href="#http_upstreams_http_upstream_name_servers_http_upstream_server_id">/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}</a></li>
<li><a href="#http_keyvals_">/http/keyvals/</a></li>
<li><a href="#http_keyvals_http_keyval_zone_name">/http/keyvals/{httpKeyvalZoneName}</a></li>
<li><a href="#stream_">/stream/</a></li>
<li><a href="#stream_server_zones_">/stream/server_zones/</a></li>
<li><a href="#stream_server_zones_stream_server_zone_name">/stream/server_zones/{streamServerZoneName}</a></li>
<li><a href="#stream_limit_conns_">/stream/limit_conns/</a></li>
<li><a href="#stream_limit_conns_stream_limit_conn_zone_name">/stream/limit_conns/{streamLimitConnZoneName}</a></li>
<li><a href="#stream_upstreams_">/stream/upstreams/</a></li>
<li><a href="#stream_upstreams_stream_upstream_name_">/stream/upstreams/{streamUpstreamName}/</a></li>
<li><a href="#stream_upstreams_stream_upstream_name_servers_">/stream/upstreams/{streamUpstreamName}/servers/</a></li>
<li><a href="#stream_upstreams_stream_upstream_name_servers_stream_upstream_server_id">/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}</a></li>
<li><a href="#stream_keyvals_">/stream/keyvals/</a></li>
<li><a href="#stream_keyvals_stream_keyval_zone_name">/stream/keyvals/{streamKeyvalZoneName}</a></li>
<li><a href="#stream_zone_sync_">/stream/zone_sync/</a></li>
<li><a href="#resolvers_">/resolvers/</a></li>
<li><a href="#resolvers_resolver_zone_name">/resolvers/{resolverZoneName}</a></li>
<li><a href="#ssl">/ssl</a></li>
</ul>
</li>
<li><a href="#definitions">Response Objects</a><br><a href="" id="summary"></a></li>
</ul>
<p><code>ngx_http_api_module</code>模块(1.13.3)提供 REST API，用于访问各种状态信息，动态配置上游服务器组以及管理<a href="http-ngx_http_keyval_module.html">key-value pairs</a>，而无需重新配置 nginx。</p>
<div class="alert callout info"><p class="title"><i class="fa fa-info-circle"></i>Note</p><div><p>该模块取代了<a href="http-ngx_http_status_module.html">ngx_http_status_module</a>和<a href="http-ngx_http_upstream_conf_module.html">ngx_http_upstream_conf_module</a>模块。</p>
</div></div>
<p>使用<code>PATCH</code>或<code>POST</code>方法时，请确保有效载荷不超过<a href="http-ngx_http_core_module.html#client_body_buffer_size">buffer size</a>以读取客户端请求正文，否则，可能会返回 413(请求实体太大)错误。</p>
<div class="alert callout info"><p class="title"><i class="fa fa-info-circle"></i>Note</p><div><p>此模块可作为<a href="javascript:window.open('https://nginx.com/products/');" target="_blank" rel="noopener noreferrer">commercial subscription</a>的一部分使用。</p>
</div></div>
<p><a href="" id="example"></a></p>
<h4 id="example-configuration"><a href="#example-configuration" id="example-configuration"></a>Example Configuration</h4>
<pre><code class="hljs language-shell">http {
    upstream backend {
        zone http_backend 64k;

        server backend1.example.com weight=5;
        server backend2.example.com;
    }

    proxy_cache_path /data/nginx/cache_backend keys_zone=cache_backend:10m;

    server {
        server_name backend.example.com;

        location / {
            proxy_pass  http://backend;
            proxy_cache cache_backend;

            health_check;
        }

        status_zone server_backend;
    }

    keyval_zone zone=one:32k state=one.keyval;
    keyval $arg_text $text zone=one;

    server {
        listen 127.0.0.1;

        location /api {
            api write=on;
            allow 127.0.0.1;
            deny all;
        }
    }
}

stream {
    upstream backend {
        zone stream_backend 64k;

        server backend1.example.com:12345 weight=5;
        server backend2.example.com:12345;
    }

    server {
        listen      127.0.0.1:12345;
        proxy_pass  backend;
        status_zone server_backend;
        health_check;
    }
}
</code></pre>
<p>所有 API 请求都在 URI 中包含受支持的 API <a href="#api_version">version</a>。具有此配置的 API 请求示例：</p>
<pre><code class="hljs language-shell">http://127.0.0.1/api/6/
http://127.0.0.1/api/6/nginx
http://127.0.0.1/api/6/connections
http://127.0.0.1/api/6/http/requests
http://127.0.0.1/api/6/http/server_zones/server_backend
http://127.0.0.1/api/6/http/caches/cache_backend
http://127.0.0.1/api/6/http/upstreams/backend
http://127.0.0.1/api/6/http/upstreams/backend/servers/
http://127.0.0.1/api/6/http/upstreams/backend/servers/1
http://127.0.0.1/api/6/http/keyvals/one?key=arg1
http://127.0.0.1/api/6/stream/
http://127.0.0.1/api/6/stream/server_zones/server_backend
http://127.0.0.1/api/6/stream/upstreams/
http://127.0.0.1/api/6/stream/upstreams/backend
http://127.0.0.1/api/6/stream/upstreams/backend/servers/1
</code></pre>
<p><a href="" id="directives"></a></p>
<h4 id="directives"><a href="#directives" id="directives"></a>Directives</h4>
<p><a href="" id="api"></a></p>
<table>
<thead></thead>
<tbody>
<tr><td>Syntax:</td><td><code>api [write=on|off];</code></td></tr>
<tr><td>Default:</td><td>—</td></tr>
<tr><td>Context:</td><td><code>location</code></td></tr>
</tbody>
</table>
<p>打开周围位置的 REST API 接口。可以访问此位置<a href="http-ngx_http_core_module.html#satisfy">limited</a>。</p>
<p><code>write</code>参数确定 API 是只读的还是读写的。默认情况下，API 是只读的。</p>
<p><a href="" id="api_version"></a></p>
<p>所有 API 请求都应在 URI 中包含受支持的 API 版本。如果请求 URI 等于位置前缀，则返回支持的 API 版本列表。当前的 API 版本是“ <code>6</code>”。</p>
<p>请求行中的可选“ <code>fields</code>”参数指定将输出所请求对象的哪些字段：</p>
<pre><code class="hljs language-shell">http://127.0.0.1/api/6/nginx?fields=version,build
</code></pre>
<p><a href="" id="status_zone"></a></p>
<table>
<thead></thead>
<tbody>
<tr><td>Syntax:</td><td><code>status_zone zone;</code></td></tr>
<tr><td>Default:</td><td>—</td></tr>
<tr><td>Context:</td><td><code>server</code> , <code>location</code> , <code>if in location</code></td></tr>
</tbody>
</table>
<p>该指令出现在 1.13.12 版中。</p>
<p>启用对指定的<code>zone</code>中的虚拟<a href="http-ngx_http_core_module.html#server">http</a>或<a href="stream-ngx_stream_core_module.html#server">stream</a>服务器状态信息的收集。多个服务器可以共享同一区域。</p>
<p><a href="" id="status_zone_location"></a></p>
<p>从 1.17.0 开始，可以按照<a href="http-ngx_http_core_module.html#location">location</a>收集状态信息。特殊值<code>off</code>禁用嵌套位置块中的统计信息收集。注意，统计是在处理结束的位置的上下文中收集的。如果在请求处理期间发生<a href="http-ngx_http_core_module.html#internal">internal redirect</a>，它可能与原始位置不同。</p>
<p><a href="" id="compatibility"></a></p>
<h4 id="compatibility"><a href="#compatibility" id="compatibility"></a>Compatibility</h4>
<ul>
<li>
<p><a href="#stream_limit_conns_">/stream/limit_conns/</a>数据已添加到<a href="#api_version">version</a> 6.</p>
</li>
<li>
<p><a href="#http_limit_conns_">/http/limit_conns/</a>数据已添加到<a href="#api_version">version</a> 6.</p>
</li>
<li>
<p><a href="#http_limit_reqs_">/http/limit_reqs/</a>数据已添加到<a href="#api_version">version</a> 6.</p>
</li>
<li>
<p><a href="http-ngx_http_keyval_module.html">key-value</a>对的“ <code>expire</code>”参数可以是<a href="#postHttpKeyvalZoneData">set</a>或<a href="#patchHttpKeyvalZoneKeyValue">changed</a>，因为<a href="#api_version">version</a>是 5.</p>
</li>
<li>
<p><a href="#resolvers_">/resolvers/</a>数据已添加到<a href="#api_version">version</a> 5.</p>
</li>
<li>
<p><a href="#http_location_zones_">/http/location_zones/</a>数据已添加到<a href="#api_version">version</a> 5.</p>
</li>
<li>
<p><a href="#def_nginx_error">nginx 错误对象</a>的<code>path</code>和<code>method</code>字段已在<a href="#api_version">version</a> 4 中删除。这些字段在较早的 api 版本中 continue 存在，但显示为空值。</p>
</li>
<li>
<p><a href="#stream_zone_sync_">/stream/zone_sync/</a>数据已添加到<a href="#api_version">version</a> 3 中。</p>
</li>
<li>
<p><a href="#def_nginx_http_upstream_conf_server">drain</a>参数已添加到<a href="#api_version">version</a> 2 中。</p>
</li>
<li>
<p><a href="#stream_keyvals_">/stream/keyvals/</a>数据已添加到<a href="#api_version">version</a> 2 中。</p>
</li>
</ul>
<p><a href="" id="endpoints"></a></p>
<h4 id="endpoints"><a href="#endpoints" id="endpoints"></a>Endpoints</h4>
<h4><a href="#root" id="root"></a> /</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-返回根端点的列表</p>
</li>
</ul>
<p>返回根端点的列表。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回字符串数组</p>
<ul>
<li id="getAPIEndpoints">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="nginx"><a href="#nginx" id="nginx"></a> /nginx</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-Nginx 运行实例的返回状态</p>
</li>
</ul>
<p>返回 nginx 版本，内部版本名称，地址，配置重载次数，主进程和工作进程的 ID。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出 nginx 运行实例的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_object">nginx</a></p>
<ul>
<li id="getNginx">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="processes"><a href="#processes" id="processes"></a> /processes</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-返回 nginx 进程状态</p>
</li>
</ul>
<p>返回异常终止和重新生成的子进程的数量。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_processes">Processes</a></p>
<ul>
<li id="getProcesses">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置 nginx 进程统计信息</p>
</li>
</ul>
<p>重置异常终止和重生的子进程的计数器。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteProcesses">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="connections"><a href="#connections" id="connections"></a> /connections</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-返回客户端连接统计信息</p>
</li>
</ul>
<p>返回客户端连接的统计信息。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出连接统计信息的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_connections">Connections</a></p>
<ul>
<li id="getConnections">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置客户端连接统计信息</p>
</li>
</ul>
<p>重置接受和删除的客户端连接的统计信息。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteConnections">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="slabs"><a href="#slabs_" id="slabs_"></a> /slabs/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-所有平板的 return 状态</p>
</li>
</ul>
<p>使用平板分配器返回每个共享内存区域的平板状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出平板区域的哪些字段。如果“ <code>fields</code>”值为空，则仅输出区域名称。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有平板返回“ <a href="#def_nginx_slab_zone">与平板分配器共享的内存区域</a>”对象的集合</p>
<ul>
<li id="getSlabs">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="slabs-1"><a href="#slabs_slab_zone_name" id="slabs_slab_zone_name"></a><span slabzonename=""> /slabs/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>slabZoneName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>使用平板分配器的共享内存区域的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-平板的返回状态</li>
</ul>
<p>使用平板分配器返回特定共享内存区域的平板状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出平板区域的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_slab_zone">与平板分配器共享的内存区域</a></p>
<ul>
<li id="getSlabZone">404 -未找到平板(<code>SlabNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置平板统计</p>
</li>
</ul>
<p>重置每个内存插槽的“ <code>reqs</code>”和“ <code>fails</code>”度量。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -未找到平板(<code>SlabNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteSlabZoneStats">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="http"><a href="#http_" id="http_"></a> /http/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-返回 HTTP 相关端点的列表</p>
</li>
</ul>
<p>返回一级 HTTP 端点的列表。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回字符串数组</p>
<ul>
<li id="getHttp">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="httprequests"><a href="#http_requests" id="http_requests"></a> /http/requests</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-返回 HTTP 请求统计信息</p>
</li>
</ul>
<p>返回客户端 HTTP 请求的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出客户端 HTTP 请求统计信息的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_http_requests">HTTP Requests</a></p>
<ul>
<li id="getHttpRequests">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置 HTTP 请求统计信息</p>
</li>
</ul>
<p>重置客户端 HTTP 请求总数。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteHttpRequests">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="httpserver-zones"><a href="#http_server_zones_" id="http_server_zones_"></a> /http/server_zones/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-所有 HTTP 服务器区域的返回状态</p>
</li>
</ul>
<p>返回每个 HTTP <a href="#status_zone">server zone</a>的状态信息。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出服务器区域的哪些字段。如果“ <code>fields</code>”值为空，则仅输出服务器区域名称。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有 HTTP 服务器区域返回“ <a href="#def_nginx_http_server_zone">HTTP 服务器区域</a>”对象的集合</p>
<ul>
<li id="getHttpServerZones">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="httpserver-zones-1"><a href="#http_server_zones_http_server_zone_name" id="http_server_zones_http_server_zone_name"></a><span httpserverzonename=""> /http/server_zones/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>httpServerZoneName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>HTTP 服务器区域的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-HTTP 服务器区域的返回状态</li>
</ul>
<p>返回特定 HTTP 服务器区域的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出服务器区域的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_http_server_zone">HTTP 服务器区域</a></p>
<ul>
<li id="getHttpServerZone">404 -找不到服务器区域(<code>ServerZoneNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置 HTTP 服务器区域的统计信息</p>
</li>
</ul>
<p>重置特定 HTTP 服务器区域中接受和丢弃的请求，响应，已接收和已发送字节的统计信息。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -找不到服务器区域(<code>ServerZoneNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteHttpServerZoneStat">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="httplocation-zones"><a href="#http_location_zones_" id="http_location_zones_"></a> /http/location_zones/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-所有 HTTP 位置区域的返回状态</p>
</li>
</ul>
<p>返回每个 HTTP <a href="#status_zone_location">location zone</a>的状态信息。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出位置区域的哪些字段。如果“ <code>fields</code>”值为空，则仅输出区域名称。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有 HTTP 位置区域返回“ <a href="#def_nginx_http_location_zone">HTTP 位置区域</a>”对象的集合</p>
<ul>
<li id="getHttpLocationZones">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="httplocation-zones-1"><a href="#http_location_zones_http_location_zone_name" id="http_location_zones_http_location_zone_name"></a><span httplocationzonename=""> /http/location_zones/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>httpLocationZoneName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>HTTP <a href="#status_zone_location">location zone</a>的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-HTTP 位置区域的返回状态</li>
</ul>
<p>返回特定 HTTP <a href="#status_zone_location">location zone</a>的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出位置区域的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_http_location_zone">HTTP 位置区域</a></p>
<ul>
<li id="getHttpLocationZone">404 -找不到位置区域(<code>LocationZoneNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置位置区域的统计信息。</p>
</li>
</ul>
<p>重置特定位置区域中接受和丢弃的请求，响应，已接收和已发送字节的统计信息。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -找不到位置区域(<code>LocationZoneNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteHttpLocationZoneStat">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="httpcaches"><a href="#http_caches_" id="http_caches_"></a> /http/caches/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-所有缓存的返回状态</p>
</li>
</ul>
<p>返回由<a href="http-ngx_http_proxy_module.html#proxy_cache_path">proxy_cache_path</a>和其他“ <code>*_cache_path</code>”指令配置的每个缓存的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出高速缓存区域的哪些字段。如果“ <code>fields</code>”值为空，则仅输出缓存区域的名称。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有 HTTP 缓存返回“ <a href="#def_nginx_http_cache">HTTP Cache</a>”对象的集合</p>
<ul>
<li id="getHttpCaches">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="httpcaches-1"><a href="#http_caches_http_cache_zone_name" id="http_caches_http_cache_zone_name"></a><span httpcachezonename=""> /http/caches/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>httpCacheZoneName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>缓存区域的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-缓存的返回状态</li>
</ul>
<p>返回特定缓存的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出缓存区域的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_http_cache">HTTP Cache</a></p>
<ul>
<li id="getHttpCacheZone">404 -未找到缓存(<code>CacheNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置缓存统计信息</p>
</li>
</ul>
<p>重置特定缓存区域中缓存命中/未命中的统计信息。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -未找到缓存(<code>CacheNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteHttpCacheZoneStat">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="httplimit-conns"><a href="#http_limit_conns_" id="http_limit_conns_"></a> /http/limit_conns/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-所有 HTTP limit_conn 区域的返回状态</p>
</li>
</ul>
<p>返回每个 HTTP <a href="http-ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zone</a>的状态信息。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出 limit_conn 区域的哪些字段。如果“ <code>fields</code>”值为空，则仅输出区域名称。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有 HTTP 限制连接返回“ <a href="#def_nginx_http_limit_conn_zone">HTTP 连接限制</a>”对象的集合</p>
<ul>
<li id="getHttpLimitConnZones">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="httplimit-conns-1"><a href="#http_limit_conns_http_limit_conn_zone_name" id="http_limit_conns_http_limit_conn_zone_name"></a><span httplimitconnzonename=""> /http/limit_conns/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>httpLimitConnZoneName</code>(<code>string</code>，为必填项)</p>
<ul>
<li><a href="http-ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zone</a>的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-HTTP limit_conn 区域的返回状态</li>
</ul>
<p>返回特定 HTTP <a href="http-ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zone</a>的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出<a href="http-ngx_http_limit_conn_module.html#limit_conn_zone">limit_conn zone</a>的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_http_limit_conn_zone">HTTP 连接限制</a></p>
<ul>
<li id="getHttpLimitConnZone">404 -找不到 limit_conn(<code>LimitConnNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置 HTTP limit_conn 区域的统计信息</p>
</li>
</ul>
<p>重置连接限制统计信息。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -未找到 limit_conn(<code>LimitConnNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteHttpLimitConnZoneStat">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="httplimit-reqs"><a href="#http_limit_reqs_" id="http_limit_reqs_"></a> /http/limit_reqs/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-所有 HTTP limit_req 区域的返回状态</p>
</li>
</ul>
<p>返回每个 HTTP <a href="http-ngx_http_limit_req_module.html#limit_req_zone">limit_req zone</a>的状态信息。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出 limit_req 区域的哪些字段。如果“ <code>fields</code>”值为空，则仅输出区域名称。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有 HTTP 限制要求返回“ <a href="#def_nginx_http_limit_req_zone">HTTP 请求速率限制</a>”对象的集合</p>
<ul>
<li id="getHttpLimitReqZones">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="httplimit-reqs-1"><a href="#http_limit_reqs_http_limit_req_zone_name" id="http_limit_reqs_http_limit_req_zone_name"></a><span httplimitreqzonename=""> /http/limit_reqs/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>httpLimitReqZoneName</code>(<code>string</code>，为必填项)</p>
<ul>
<li><a href="http-ngx_http_limit_req_module.html#limit_req_zone">limit_req zone</a>的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-HTTP limit_req 区域的返回状态</li>
</ul>
<p>返回特定 HTTP <a href="http-ngx_http_limit_req_module.html#limit_req_zone">limit_req zone</a>的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出<a href="http-ngx_http_limit_req_module.html#limit_req_zone">limit_req zone</a>的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_http_limit_req_zone">HTTP 请求速率限制</a></p>
<ul>
<li id="getHttpLimitReqZone">404 -找不到 limit_req(<code>LimitReqNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置 HTTP limit_req 区域的统计信息</p>
</li>
</ul>
<p>重置请求限制统计信息。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -未找到 limit_req(<code>LimitReqNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteHttpLimitReqZoneStat">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="httpupstreams"><a href="#http_upstreams_" id="http_upstreams_"></a> /http/upstreams/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-所有 HTTP 上游服务器组的返回状态</p>
</li>
</ul>
<p>返回每个 HTTP 上游服务器组及其服务器的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出上游服务器组的哪些字段。如果“ <code>fields</code>”值为空，则仅输出上游名称。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有 HTTP 上游返回“ <a href="#def_nginx_http_upstream">HTTP Upstream</a>”对象的集合</p>
<ul>
<li id="getHttpUpstreams">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="httpupstreams-1"><a href="#http_upstreams_http_upstream_name_" id="http_upstreams_http_upstream_name_"></a><span httpupstreamname=""> /http/upstreams/</span>/</h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>httpUpstreamName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>HTTP 上游服务器组的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-HTTP 上游服务器组的返回状态</li>
</ul>
<p>返回特定的 HTTP 上游服务器组及其服务器的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出上游服务器组的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_http_upstream">HTTP Upstream</a></p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="getHttpUpstreamName">
<p>404 -未知版本(<code>UnknownVersion</code>)，未找到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置 HTTP 上游服务器组的统计信息</p>
</li>
</ul>
<p>重置上游服务器组中每个上游服务器的统计信息和队列统计信息。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>404 -未知版本(<code>UnknownVersion</code>)，找不到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteHttpUpstreamStat">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="httpupstreamsservers"><a href="#http_upstreams_http_upstream_name_servers_" id="http_upstreams_http_upstream_name_servers_"></a><span httpupstreamname=""> /http/upstreams/</span>/servers/</h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>httpUpstreamName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>上游服务器组的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-返回 HTTP 上游服务器组中所有服务器的配置</li>
</ul>
<p>返回特定 HTTP 上游服务器组中每个服务器的配置。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回数组<a href="#def_nginx_http_upstream_conf_server">HTTP 上游服务器</a></p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="getHttpUpstreamServers">
<p>404 -未知版本(<code>UnknownVersion</code>)，未找到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
<li>
<p><code>POST</code>-将服务器添加到 HTTP 上游服务器组</p>
</li>
</ul>
<p>将新服务器添加到 HTTP 上游服务器组。服务器参数以 JSON 格式指定。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>postHttpUpstreamServer</code>(<a href="#def_nginx_http_upstream_conf_server">HTTP 上游服务器</a>，为必填项)</p>
<ul>
<li>新服务器的地址以及其他 JSON 格式的可选参数。参数“ <code>ID</code>”，“ <code>backup</code>”和“ <code>service</code>”不能更改。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>201 -创建后返回<a href="#def_nginx_http_upstream_conf_server">HTTP 上游服务器</a></p>
<ul>
<li>
<p>400 -上游是静态的(<code>UpstreamStatic</code>)，无效的“ <code>parameter</code>”值(<code>UpstreamConfFormatError</code>)，缺少“ <code>server</code>”参数(<code>UpstreamConfFormatError</code>)，未知参数“ <code>name</code>”(<code>UpstreamConfFormatError</code>)，嵌套对象或列表(<code>UpstreamConfFormatError</code>)，解析时为<code>error</code> <code>UpstreamBadAddress</code>)，服务上游“ <code>host</code>”可能没有端口(<code>UpstreamBadAddress</code>)，服务上游“ <code>host</code>”要求域名(<code>UpstreamBadAddress</code>)，无效“ <code>weight</code>”(<code>UpstreamBadWeight</code>)，无效“ <code>max_conns</code>”(<code>UpstreamBadMaxConns</code>)，无效“ <code>max_fails</code>”(<code>UpstreamBadMaxFails</code>)，无效的“ <code>fail_timeout</code>”(<code>UpstreamBadFailTimeout</code>)，无效的“ <code>slow_start</code>”(<code>UpstreamBadSlowStart</code>)，读取请求正文失败<code>BodyReadError</code>)，路由太长(<code>UpstreamBadRoute</code>)，“ <code>service</code>”为空(<code>UpstreamBadService</code>)，未定义要解析的解析器(<code>UpstreamConfNoResolver</code>) ，上游“ <code>name</code>”没有备份(<code>UpstreamNoBackup</code>)，上游“ <code>name</code>”内存用尽(<code>UpstreamOutOfMemory</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>404 -未知版本(<code>UnknownVersion</code>)，找不到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>409 -条目存在(<code>EntryExists</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="postHttpUpstreamServer">
<p>415 -JSON 错误(<code>JsonError</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="httpupstreamsservers-1"><a href="#http_upstreams_http_upstream_name_servers_http_upstream_server_id" id="http_upstreams_http_upstream_name_servers_http_upstream_server_id"></a><span httpupstreamname=""> /http/upstreams/</span><span httpupstreamserverid="">/servers/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>httpUpstreamName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>
<p>上游服务器组的名称。</p>
</li>
<li>
<p><code>httpUpstreamServerId</code>(<code>string</code>，为必填项)</p>
<ul>
<li>服务器的 ID。</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-返回 HTTP 上游服务器组中服务器的配置</li>
</ul>
<p>返回 HTTP 上游服务器组中特定服务器的配置。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_http_upstream_conf_server">HTTP 上游服务器</a></p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，无效的服务器 ID(<code>UpstreamBadServerId</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="getHttpUpstreamPeer">
<p>404 -ID 为“ <code>id</code>”的服务器不存在(<code>UpstreamServerNotFound</code>)，未知版本(<code>UnknownVersion</code>)，找不到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
<li>
<p><code>PATCH</code>-修改 HTTP 上游服务器组中的服务器</p>
</li>
</ul>
<p>修改 HTTP 上游服务器组中特定服务器的设置。服务器参数以 JSON 格式指定。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>patchHttpUpstreamServer</code>(<a href="#def_nginx_http_upstream_conf_server">HTTP 上游服务器</a>，为必填项)</p>
<ul>
<li>服务器参数，以 JSON 格式指定。参数“ <code>ID</code>”，“ <code>backup</code>”和“ <code>service</code>”不能更改。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_http_upstream_conf_server">HTTP 上游服务器</a></p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，无效的“ <code>parameter</code>”值(<code>UpstreamConfFormatError</code>)，未知参数“ <code>name</code>”(<code>UpstreamConfFormatError</code>)，嵌套对象或列表(<code>UpstreamConfFormatError</code>)，解析时(<code>UpstreamBadAddress</code>)是<code>error</code>，参数“ <code>server</code>”无效(<code>UpstreamBadAddress</code>)，无效的服务器 ID(<code>UpstreamBadServerId</code>)，无效的“ <code>weight</code>”(<code>UpstreamBadWeight</code>)，无效的“ <code>max_conns</code>”(<code>UpstreamBadMaxConns</code>)，无效的“ <code>max_fails</code>”(<code>UpstreamBadMaxFails</code>)，无效的_ <code>fail_timeout</code>“(<code>UpstreamBadFailTimeout</code>)，无效的” <code>slow_start</code>“(<code>UpstreamBadSlowStart</code>)，读取请求正文失败<code>BodyReadError</code>)，路由太长(<code>UpstreamBadRoute</code>)，“ <code>service</code>”为空(<code>UpstreamBadService</code>)，服务器“ <code>ID</code>”的地址是不可变的(<code>UpstreamServerImmutable</code>)，服务器“ <code>ID</code>”的权重是不变的(<code>UpstreamServerWeightImmutable</code>)，上游是“ <code>name</code>”内存用完(<code>UpstreamOutOfMemory</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>404 -ID 为“ <code>id</code>”的服务器不存在(<code>UpstreamServerNotFound</code>)，未知版本(<code>UnknownVersion</code>)，找不到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="patchHttpUpstreamPeer">
<p>415 -JSON 错误(<code>JsonError</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
<li>
<p><code>DELETE</code>-从 HTTP 上游服务器组中删除服务器</p>
</li>
</ul>
<p>从 HTTP 上游服务器组中删除服务器。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回数组<a href="#def_nginx_http_upstream_conf_server">HTTP 上游服务器</a></p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，无效的服务器 ID(<code>UpstreamBadServerId</code>)，服务器“ <code>id</code>”不可移动(<code>UpstreamServerImmutable</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>404 -ID 为“ <code>id</code>”的服务器不存在(<code>UpstreamServerNotFound</code>)，未知版本(<code>UnknownVersion</code>)，找不到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteHttpUpstreamServer">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="httpkeyvals"><a href="#http_keyvals_" id="http_keyvals_"></a> /http/keyvals/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-从所有 HTTP keyval 区域返回键/值对</p>
</li>
</ul>
<p>返回每个 HTTP 键值共享内存<a href="http-ngx_http_keyval_module.html#keyval_zone">zone</a>的键值对。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>如果“ <code>fields</code>”值为空，则仅输出 HTTP keyval 区域名称。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有 HTTP 键值返回“ <a href="#def_nginx_http_keyval_zone">HTTP 密钥共享存储区</a>”对象的集合</p>
<ul>
<li id="getHttpKeyvalZones">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="httpkeyvals-1"><a href="#http_keyvals_http_keyval_zone_name" id="http_keyvals_http_keyval_zone_name"></a><span httpkeyvalzonename=""> /http/keyvals/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>httpKeyvalZoneName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>HTTP keyval 共享内存区域的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-从 HTTP keyval 区域返回键/值对</li>
</ul>
<p>返回存储在特定 HTTP keyval 共享内存<a href="http-ngx_http_keyval_module.html#keyval_zone">zone</a>中的键/值对。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>key</code>(<code>string</code>，可选)</p>
<ul>
<li>从 HTTP keyval 区域获取特定的键值对。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_http_keyval_zone">HTTP 密钥共享存储区</a></p>
<ul>
<li id="getHttpKeyvalZoneKeysValues">404 -未找到键值(<code>KeyvalNotFound</code>)，未找到键值键(<code>KeyvalKeyNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>POST</code>-将键值对添加到 HTTP keyval 区域</p>
</li>
</ul>
<p>将新的键值对添加到 HTTP keyval 共享内存<a href="http-ngx_http_keyval_module.html#keyval_zone">zone</a>。如果 HTTP keyval 共享内存区域为空，则可以输入几个键值对。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>Key-value</code>(<a href="#def_nginx_http_keyval_zone_post_patch">HTTP 密钥共享存储区</a>，为必填项)</p>
<ul>
<li>键值对以 JSON 格式指定。如果 HTTP keyval 共享内存区域为空，则可以输入几个键值对。可以使用<code>expire</code>参数(覆盖<a href="http-ngx_http_keyval_module.html#keyval_timeout">keyval_zone</a>伪指令的<a href="http-ngx_http_keyval_module.html#keyval_zone">timeout</a>参数)为键值对指定过期时间(以毫秒为单位)。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>201 -已创建</p>
<ul>
<li>
<p>400 -无效的 JSON(<code>KeyvalFormatError</code>)，无效的密钥格式(<code>KeyvalFormatError</code>)，所需的密钥(<code>KeyvalFormatError</code>)，未启用密钥超时(<code>KeyvalFormatError</code>)，只能添加一个密钥(<code>KeyvalFormatError</code>)，读取请求正文失败<code>BodyReadError</code>，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>404 -找不到密钥(<code>KeyvalNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>409 -条目存在(<code>EntryExists</code>)，键已经存在(<code>KeyvalKeyExists</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>413 -请求实体太大，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="postHttpKeyvalZoneData">
<p>415 -JSON 错误(<code>JsonError</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
<li>
<p><code>PATCH</code>-修改键值或删除键</p>
</li>
</ul>
<p>更改键值对中所选键的值，通过将键值设置为<code>null</code>来删除键，更改键值对的到期时间。如果启用了群集中的关键密钥区域的<a href="stream-ngx_stream_zone_sync_module.html#zone_sync">synchronization</a>，则仅删除目标群集节点上的密钥。可以使用<code>expire</code>参数(覆盖<a href="http-ngx_http_keyval_module.html#keyval_timeout">keyval_zone</a>指令的<a href="http-ngx_http_keyval_module.html#keyval_zone">timeout</a>参数)为键值对指定过期时间(以毫秒为单位)。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>httpKeyvalZoneKeyValue</code>(<a href="#def_nginx_http_keyval_zone_post_patch">HTTP 密钥共享存储区</a>，为必填项)</p>
<ul>
<li>密钥的新值以 JSON 格式指定。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>400 -无效的 JSON(<code>KeyvalFormatError</code>)，需要密钥(<code>KeyvalFormatError</code>)，未启用密钥 val 超时(<code>KeyvalFormatError</code>)，只能更新一个密钥(<code>KeyvalFormatError</code>)，读取请求正文失败<code>BodyReadError</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>404 -未找到键值(<code>KeyvalNotFound</code>)，未找到键值键(<code>KeyvalKeyNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>413 -请求实体太大，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="patchHttpKeyvalZoneKeyValue">
<p>415 -JSON 错误(<code>JsonError</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
<li>
<p><code>DELETE</code>-清空 HTTP keyval 区域</p>
</li>
</ul>
<p>从 HTTP keyval 共享内存<a href="http-ngx_http_keyval_module.html#keyval_zone">zone</a>删除所有键值对。如果启用了群集中<a href="stream-ngx_stream_zone_sync_module.html#zone_sync">synchronization</a>的关键密钥区，则仅清空目标集群节点上的关键密钥区。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -找不到密钥(<code>KeyvalNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteHttpKeyvalZoneData">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="stream"><a href="#stream_" id="stream_"></a> /stream/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-返回与流相关的端点的列表</p>
</li>
</ul>
<p>返回一级流端点的列表。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回字符串数组</p>
<ul>
<li id="getStream">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="streamserver-zones"><a href="#stream_server_zones_" id="stream_server_zones_"></a> /stream/server_zones/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-所有流服务器区域的返回状态</p>
</li>
</ul>
<p>返回每个流<a href="#status_zone">server zone</a>的状态信息。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出服务器区域的哪些字段。如果“ <code>fields</code>”值为空，则仅输出服务器区域名称。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有流服务器区域返回“ <a href="#def_nginx_stream_server_zone">流服务器区域</a>”对象的集合</p>
<ul>
<li id="getStreamServerZones">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="streamserver-zones-1"><a href="#stream_server_zones_stream_server_zone_name" id="stream_server_zones_stream_server_zone_name"></a><span streamserverzonename=""> /stream/server_zones/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>streamServerZoneName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>流服务器区域的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-流服务器区域的返回状态</li>
</ul>
<p>返回特定流服务器区域的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出服务器区域的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_stream_server_zone">流服务器区域</a></p>
<ul>
<li id="getStreamServerZone">404 -找不到服务器区域(<code>ServerZoneNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置流服务器区域的统计信息</p>
</li>
</ul>
<p>重置特定流服务器区域中接受和丢弃的连接，会话，已接收和已发送字节的统计信息。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -找不到服务器区域(<code>ServerZoneNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteStreamServerZoneStat">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="streamlimit-conns"><a href="#stream_limit_conns_" id="stream_limit_conns_"></a> /stream/limit_conns/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-所有流 limit_conn 区域的返回状态</p>
</li>
</ul>
<p>返回每个流<a href="stream-ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zone</a>的状态信息。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出 limit_conn 区域的哪些字段。如果“ <code>fields</code>”值为空，则仅输出区域名称。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有流限制 conns 返回“ <a href="#def_nginx_stream_limit_conn_zone">流连接限制</a>”对象的集合</p>
<ul>
<li id="getStreamLimitConnZones">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="streamlimit-conns-1"><a href="#stream_limit_conns_stream_limit_conn_zone_name" id="stream_limit_conns_stream_limit_conn_zone_name"></a><span streamlimitconnzonename=""> /stream/limit_conns/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>streamLimitConnZoneName</code>(<code>string</code>，为必填项)</p>
<ul>
<li><a href="stream-ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zone</a>的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-流 limit_conn 区域的返回状态</li>
</ul>
<p>返回特定流<a href="stream-ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zone</a>的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出<a href="stream-ngx_stream_limit_conn_module.html#limit_conn_zone">limit_conn zone</a>的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_stream_limit_conn_zone">流连接限制</a></p>
<ul>
<li id="getStreamLimitConnZone">404 -找不到 limit_conn(<code>LimitConnNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置流 limit_conn 区域的统计信息</p>
</li>
</ul>
<p>重置连接限制统计信息。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -未找到 limit_conn(<code>LimitConnNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteStreamLimitConnZoneStat">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="streamupstreams"><a href="#stream_upstreams_" id="stream_upstreams_"></a> /stream/upstreams/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-所有流上游服务器组的返回状态</p>
</li>
</ul>
<p>返回每个流上游服务器组及其服务器的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出上游服务器组的哪些字段。如果“ <code>fields</code>”值为空，则仅输出上游名称。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有流上游返回“ <a href="#def_nginx_stream_upstream">Stream Upstream</a>”对象的集合</p>
<ul>
<li id="getStreamUpstreams">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="streamupstreams-1"><a href="#stream_upstreams_stream_upstream_name_" id="stream_upstreams_stream_upstream_name_"></a><span streamupstreamname=""> /stream/upstreams/</span>/</h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>streamUpstreamName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>流上游服务器组的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-流上游服务器组的返回状态</li>
</ul>
<p>返回特定流上游服务器组及其服务器的状态。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出上游服务器组的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_stream_upstream">Stream Upstream</a></p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="getStreamUpstream">
<p>404 -未知版本(<code>UnknownVersion</code>)，未找到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置流上游服务器组的统计信息</p>
</li>
</ul>
<p>重置上游服务器组中每个上游服务器的统计信息。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>404 -未知版本(<code>UnknownVersion</code>)，找不到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteStreamUpstreamStat">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="streamupstreamsservers"><a href="#stream_upstreams_stream_upstream_name_servers_" id="stream_upstreams_stream_upstream_name_servers_"></a><span streamupstreamname=""> /stream/upstreams/</span>/servers/</h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>streamUpstreamName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>上游服务器组的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-返回流上游服务器组中所有服务器的配置</li>
</ul>
<p>返回特定流上游服务器组中每个服务器的配置。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回数组<a href="#def_nginx_stream_upstream_conf_server">流上游服务器</a></p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="getStreamUpstreamServers">
<p>404 -未知版本(<code>UnknownVersion</code>)，未找到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
<li>
<p><code>POST</code>-将服务器添加到流上游服务器组</p>
</li>
</ul>
<p>将新服务器添加到流上游服务器组。服务器参数以 JSON 格式指定。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>postStreamUpstreamServer</code>(<a href="#def_nginx_stream_upstream_conf_server">流上游服务器</a>，为必填项)</p>
<ul>
<li>新服务器的地址以及其他 JSON 格式的可选参数。参数“ <code>ID</code>”，“ <code>backup</code>”和“ <code>service</code>”不能更改。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>201 -创建后返回<a href="#def_nginx_stream_upstream_conf_server">流上游服务器</a></p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，无效的“ <code>parameter</code>”值(<code>UpstreamConfFormatError</code>)，缺少“ <code>server</code>”参数(<code>UpstreamConfFormatError</code>)，未知参数“ <code>name</code>”(<code>UpstreamConfFormatError</code>)，嵌套对象或列表(<code>UpstreamConfFormatError</code>)，解析时为<code>error</code> <code>UpstreamBadAddress</code>)，服务器“ <code>host</code>”(<code>UpstreamBadAddress</code>)中没有端口，上游服务“ <code>host</code>”可能没有端口(<code>UpstreamBadAddress</code>)，上游服务“ <code>host</code>”需要域名(<code>UpstreamBadAddress</code>)，无效的“ <code>weight</code>”(<code>UpstreamBadWeight</code>)，无效的<code>max_conns</code> “(<code>UpstreamBadMaxConns</code>)，无效” <code>max_fails</code>“(<code>UpstreamBadMaxFails</code>)，无效” <code>fail_timeout</code>“(<code>UpstreamBadFailTimeout</code>)，无效” <code>slow_start</code>“(<code>UpstreamBadSlowStart</code>)，” <code>service</code>“为空(<code>UpstreamBadService</code>)，未定义解析器来解析(<code>UpstreamConfNoResolver</code>)，上游是” <code>name</code>没有备份(<code>UpstreamNoBackup</code>)，上游“ <code>name</code>”内存已用尽(<code>UpstreamOutOfMemory</code>)，读取请求正文失败<code>BodyReadError</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>404 -未知版本(<code>UnknownVersion</code>)，找不到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>409 -条目存在(<code>EntryExists</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="postStreamUpstreamServer">
<p>415 -JSON 错误(<code>JsonError</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="streamupstreamsservers-1"><a href="#stream_upstreams_stream_upstream_name_servers_stream_upstream_server_id" id="stream_upstreams_stream_upstream_name_servers_stream_upstream_server_id"></a><span streamupstreamname=""> /stream/upstreams/</span><span streamupstreamserverid="">/servers/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>streamUpstreamName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>
<p>上游服务器组的名称。</p>
</li>
<li>
<p><code>streamUpstreamServerId</code>(<code>string</code>，为必填项)</p>
<ul>
<li>服务器的 ID。</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-返回流上游服务器组中服务器的配置</li>
</ul>
<p>返回流上游服务器组中特定服务器的配置。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_stream_upstream_conf_server">流上游服务器</a></p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，无效的服务器 ID(<code>UpstreamBadServerId</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="getStreamUpstreamServer">
<p>404 -未知版本(<code>UnknownVersion</code>)，上游未找到(<code>UpstreamNotFound</code>)，ID 为_ <code>id</code>的服务器不存在(<code>UpstreamServerNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
<li>
<p><code>PATCH</code>-修改流上游服务器组中的服务器</p>
</li>
</ul>
<p>修改流上游服务器组中特定服务器的设置。服务器参数以 JSON 格式指定。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>patchStreamUpstreamServer</code>(<a href="#def_nginx_stream_upstream_conf_server">流上游服务器</a>，为必填项)</p>
<ul>
<li>服务器参数，以 JSON 格式指定。参数“ <code>ID</code>”，“ <code>backup</code>”和“ <code>service</code>”不能更改。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_stream_upstream_conf_server">流上游服务器</a></p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，无效的“ <code>parameter</code>”值(<code>UpstreamConfFormatError</code>)，未知参数“ <code>name</code>”(<code>UpstreamConfFormatError</code>)，嵌套对象或列表(<code>UpstreamConfFormatError</code>)，解析时(<code>UpstreamBadAddress</code>)的“ <code>error</code>”，参数“ <code>server</code>”无效(<code>UpstreamBadAddress</code>)，服务器“ <code>host</code>”(<code>UpstreamBadAddress</code>)中没有端口，无效的服务器 ID(<code>UpstreamBadServerId</code>)，无效的“ <code>weight</code>”(<code>UpstreamBadWeight</code>)，无效的“ <code>max_conns</code>”(<code>UpstreamBadMaxConns</code>)，无效的“ <code>max_fails</code>”(<code>UpstreamBadMaxFails</code>)，无效的“ <code>fail_timeout</code>”(<code>UpstreamBadFailTimeout</code>)，无效的“ <code>slow_start</code>”(<code>UpstreamBadSlowStart</code>)，读取请求正文失败<code>BodyReadError</code>)，“ <code>service</code>”为空(<code>UpstreamBadService</code>)，服务器“ <code>ID</code>”的地址是不可变的(<code>UpstreamServerImmutable</code>)，服务器“ <code>ID</code>”的权重是不可变的(<code>UpstreamServerWeightImmutable</code>)，上游“ <code>name</code>”内存用尽(<code>UpstreamOutOfMemory</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>404 -ID 为“ <code>id</code>”的服务器不存在(<code>UpstreamServerNotFound</code>)，未知版本(<code>UnknownVersion</code>)，找不到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="patchStreamUpstreamServer">
<p>415 -JSON 错误(<code>JsonError</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
<li>
<p><code>DELETE</code>-从流上游服务器组中删除服务器</p>
</li>
</ul>
<p>从流服务器组中删除服务器。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回数组<a href="#def_nginx_stream_upstream_conf_server">流上游服务器</a></p>
<ul>
<li>
<p>400 -上游是静态(<code>UpstreamStatic</code>)，无效的服务器 ID(<code>UpstreamBadServerId</code>)，服务器“ <code>id</code>”不可移动(<code>UpstreamServerImmutable</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>404 -ID 为“ <code>id</code>”的服务器不存在(<code>UpstreamServerNotFound</code>)，未知版本(<code>UnknownVersion</code>)，找不到上游(<code>UpstreamNotFound</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteStreamUpstreamServer">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="streamkeyvals"><a href="#stream_keyvals_" id="stream_keyvals_"></a> /stream/keyvals/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-从所有流 keyval 区域返回键值对</p>
</li>
</ul>
<p>返回每个流 keyval 共享内存<a href="stream-ngx_stream_keyval_module.html#keyval_zone">zone</a>的键/值对。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>如果“ <code>fields</code>”值为空，则仅输出流密钥区名称。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有流键值返回“ <a href="#def_nginx_stream_keyval_zone">流密钥共享存储区</a>”对象的集合</p>
<ul>
<li id="getStreamKeyvalZones">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="streamkeyvals-1"><a href="#stream_keyvals_stream_keyval_zone_name" id="stream_keyvals_stream_keyval_zone_name"></a><span streamkeyvalzonename=""> /stream/keyvals/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>streamKeyvalZoneName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>流 keyval 共享内存区域的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-从流 keyval 区域返回键/值对</li>
</ul>
<p>返回存储在特定流 keyval 共享内存<a href="stream-ngx_stream_keyval_module.html#keyval_zone">zone</a>中的键值对。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>key</code>(<code>string</code>，可选)</p>
<ul>
<li>从流 keyval 区域获取特定的键值对。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_stream_keyval_zone">流密钥共享存储区</a></p>
<ul>
<li id="getStreamKeyvalZoneKeysValues">404 -未找到键值(<code>KeyvalNotFound</code>)，未找到键值键(<code>KeyvalKeyNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>POST</code>-将键值对添加到流 keyval 区域</p>
</li>
</ul>
<p>将新的键/值对添加到流 keyval 共享内存<a href="stream-ngx_stream_keyval_module.html#keyval_zone">zone</a>。如果流 keyval 共享存储区为空，则可以输入几个键值对。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>Key-value</code>(<a href="#def_nginx_stream_keyval_zone_post_patch">流密钥共享存储区</a>，为必填项)</p>
<ul>
<li>键值对以 JSON 格式指定。如果流 keyval 共享存储区为空，则可以输入几个键值对。可以使用<code>expire</code>参数(覆盖<a href="stream-ngx_stream_keyval_module.html#keyval_timeout">keyval_zone</a>伪指令的<a href="stream-ngx_stream_keyval_module.html#keyval_zone">timeout</a>参数)为键值对指定过期时间(以毫秒为单位)。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>201 -已创建</p>
<ul>
<li>
<p>400 -无效的 JSON(<code>KeyvalFormatError</code>)，无效的密钥格式(<code>KeyvalFormatError</code>)，所需的密钥(<code>KeyvalFormatError</code>)，未启用密钥超时(<code>KeyvalFormatError</code>)，只能添加一个密钥(<code>KeyvalFormatError</code>)，读取请求正文失败<code>BodyReadError</code>，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>404 -找不到密钥(<code>KeyvalNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>409 -条目存在(<code>EntryExists</code>)，键已经存在(<code>KeyvalKeyExists</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>413 -请求实体太大，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="postStreamKeyvalZoneData">
<p>415 -JSON 错误(<code>JsonError</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
<li>
<p><code>PATCH</code>-修改键值或删除键</p>
</li>
</ul>
<p>更改键值对中所选键的值，通过将键值设置为<code>null</code>来删除键，更改键值对的到期时间。如果启用了群集中的关键密钥区域的<a href="stream-ngx_stream_zone_sync_module.html#zone_sync">synchronization</a>，则仅删除目标群集节点上的密钥。使用<code>expire</code>参数指定有效时间(以毫秒为单位)，该参数将覆盖<a href="stream-ngx_stream_keyval_module.html#keyval_timeout">keyval_zone</a>指令的<a href="stream-ngx_stream_keyval_module.html#keyval_zone">timeout</a>参数。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>streamKeyvalZoneKeyValue</code>(<a href="#def_nginx_stream_keyval_zone_post_patch">流密钥共享存储区</a>，为必填项)</p>
<ul>
<li>密钥的新值以 JSON 格式指定。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>400 -无效的 JSON(<code>KeyvalFormatError</code>)，需要密钥(<code>KeyvalFormatError</code>)，未启用密钥 val 超时(<code>KeyvalFormatError</code>)，只能更新一个密钥(<code>KeyvalFormatError</code>)，读取请求正文失败<code>BodyReadError</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>404 -未找到键值(<code>KeyvalNotFound</code>)，未找到键值键(<code>KeyvalKeyNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li>
<p>413 -请求实体太大，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="patchStreamKeyvalZoneKeyValue">
<p>415 -JSON 错误(<code>JsonError</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
<li>
<p><code>DELETE</code>-清空流密钥区</p>
</li>
</ul>
<p>从流 keyval 共享内存<a href="stream-ngx_stream_keyval_module.html#keyval_zone">zone</a>中删除所有键值对。如果启用了群集中<a href="stream-ngx_stream_zone_sync_module.html#zone_sync">synchronization</a>的关键密钥区，则仅清空目标集群节点上的关键密钥区。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -找不到密钥(<code>KeyvalNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteStreamKeyvalZoneData">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="streamzone-sync"><a href="#stream_zone_sync_" id="stream_zone_sync_"></a> /stream/zone_sync/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-返回节点的同步状态</p>
</li>
</ul>
<p>返回集群节点的同步状态。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_stream_zone_sync">流区同步节点</a></p>
<ul>
<li id="getStreamZoneSync">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="resolvers"><a href="#resolvers_" id="resolvers_"></a> /resolvers/</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-所有解析器区域的返回状态</p>
</li>
</ul>
<p>返回每个<a href="http-ngx_http_core_module.html#resolver_status_zone">resolver zone</a>的状态信息。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制输出解析器统计信息的字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，为所有解析器返回“ <a href="#def_nginx_resolver_zone">Resolver Zone</a>”对象的集合</p>
<ul>
<li id="getResolverZones">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
</ul>
<h4 id="resolvers-1"><a href="#resolvers_resolver_zone_name" id="resolvers_resolver_zone_name"></a><span resolverzonename=""> /resolvers/</span></h4>
<ul>
<li>
<p>所有方法共有的参数：</p>
</li>
<li>
<p><code>resolverZoneName</code>(<code>string</code>，为必填项)</p>
<ul>
<li>解析器区域的名称。</li>
</ul>
</li>
</ul>
<p>Supported methods:</p>
<ul>
<li><code>GET</code>-返回解析器区域的统计信息</li>
</ul>
<p>返回存储在特定解析器<a href="http-ngx_http_core_module.html#resolver_status_zone">zone</a>中的统计信息。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出解析器区域的哪些字段(请求，响应或两者)。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_resolver_zone">Resolver Zone</a></p>
<ul>
<li id="getResolverZone">404 -找不到解析器区域(<code>ResolverZoneNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置解析器区域的统计信息。</p>
</li>
</ul>
<p>重置特定解析器区域中的统计信息。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -找不到解析器区域(<code>ResolverZoneNotFound</code>)，未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteResolverZoneStat">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<h4 id="ssl"><a href="#ssl" id="ssl"></a> /ssl</h4>
<ul>
<li>
<p>Supported methods:</p>
</li>
<li>
<p><code>GET</code>-返回 SSL 统计信息</p>
</li>
</ul>
<p>返回 SSL 统计信息。</p>
<p>Request parameters:</p>
<ul>
<li>
<p><code>fields</code>(<code>string</code>，可选)</p>
<ul>
<li>限制将输出 SSL 统计信息的哪些字段。</li>
</ul>
</li>
</ul>
<p>Possible responses:</p>
<ul>
<li>
<p>200 -成功，返回<a href="#def_nginx_ssl_object">SSL</a></p>
<ul>
<li id="getSsl">404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></li>
</ul>
</li>
<li>
<p><code>DELETE</code>-重置 SSL 统计信息</p>
</li>
</ul>
<p>重置 SSL 握手和会话重用的计数器。</p>
<p>Possible responses:</p>
<ul>
<li>
<p>204 -成功</p>
<ul>
<li>
<p>404 -未知版本(<code>UnknownVersion</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
<li id="deleteSslStat">
<p>405 -方法已禁用(<code>MethodDisabled</code>)，返回<a href="#def_nginx_error">Error</a></p>
</li>
</ul>
</li>
</ul>
<p><a href="" id="definitions"></a></p>
<h4 id="response-objects"><a href="#response-objects" id="response-objects"></a>Response Objects</h4>
<ul>
<li>nginx:</li>
</ul>
<p>有关 Nginx 的一般信息：</p>
<ul>
<li>
<p><code>version</code> ( <code>string</code> )</p>
<ul>
<li>Nginx 的版本。</li>
</ul>
</li>
<li>
<p><code>build</code> ( <code>string</code> )</p>
<ul>
<li>Nginx 构建的名称。</li>
</ul>
</li>
<li>
<p><code>address</code> ( <code>string</code> )</p>
<ul>
<li>接受状态请求的服务器的地址。</li>
</ul>
</li>
<li>
<p><code>generation</code> ( <code>integer</code> )</p>
<ul>
<li>配置总数<a href="control.html#reconfiguration">reloads</a>。</li>
</ul>
</li>
<li>
<p><code>load_timestamp</code> ( <code>string</code> )</p>
<ul>
<li>上次重新加载配置的时间，采用 ISO 8601 格式，分辨率为毫秒。</li>
</ul>
</li>
<li>
<p><code>timestamp</code> ( <code>string</code> )</p>
<ul>
<li>ISO 8601 格式的当前时间，以毫秒为单位。</li>
</ul>
</li>
<li>
<p><code>pid</code> ( <code>integer</code> )</p>
<ul>
<li>处理状态请求的工作进程的 ID。</li>
</ul>
</li>
<li>
<p><code>ppid</code> ( <code>integer</code> )</p>
<ul>
<li>启动<a href="http-ngx_http_status_module.html#pid">worker process</a>的主进程的 ID。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_object"><code class="hljs language-shell" id="def_nginx_object">{
  &quot;nginx&quot; : {
    &quot;version&quot; : &quot;1.17.3&quot;,
    &quot;build&quot; : &quot;nginx-plus-r19&quot;,
    &quot;address&quot; : &quot;206.251.255.64&quot;,
    &quot;generation&quot; : 6,
    &quot;load_timestamp&quot; : &quot;2019-10-01T11:15:44.467Z&quot;,
    &quot;timestamp&quot; : &quot;2019-10-01T09:26:07.305Z&quot;,
    &quot;pid&quot; : 32212,
    &quot;ppid&quot; : 32210
  }
}
</code></pre>
<ul>
<li>
<p>Processes:</p>
</li>
<li>
<p><code>respawned</code> ( <code>integer</code> )</p>
<ul>
<li>异常终止和重生的子进程的总数。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_processes"><code class="hljs language-shell" id="def_nginx_processes">{
  &quot;respawned&quot; : 0
}
</code></pre>
<ul>
<li>Connections:</li>
</ul>
<p>接受，断开，活动和空闲连接的数量。</p>
<ul>
<li>
<p><code>accepted</code> ( <code>integer</code> )</p>
<ul>
<li>接受的客户端连接总数。</li>
</ul>
</li>
<li>
<p><code>dropped</code> ( <code>integer</code> )</p>
<ul>
<li>断开的客户端连接总数。</li>
</ul>
</li>
<li>
<p><code>active</code> ( <code>integer</code> )</p>
<ul>
<li>当前活动的客户端连接数。</li>
</ul>
</li>
<li>
<p><code>idle</code> ( <code>integer</code> )</p>
<ul>
<li>当前空闲的客户端连接数。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_connections"><code class="hljs language-shell" id="def_nginx_connections">{
  &quot;accepted&quot; : 4968119,
  &quot;dropped&quot; : 0,
  &quot;active&quot; : 5,
  &quot;idle&quot; : 117
}
</code></pre>
<ul>
<li>
<p>SSL:</p>
</li>
<li>
<p><code>handshakes</code> ( <code>integer</code> )</p>
<ul>
<li>成功的 SSL 握手总数。</li>
</ul>
</li>
<li>
<p><code>handshakes_failed</code> ( <code>integer</code> )</p>
<ul>
<li>SSL 握手失败的总数。</li>
</ul>
</li>
<li>
<p><code>session_reuses</code> ( <code>integer</code> )</p>
<ul>
<li>SSL 握手期间会话重用的总数。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_ssl_object"><code class="hljs language-shell" id="def_nginx_ssl_object">{
  &quot;handshakes&quot; : 79572,
  &quot;handshakes_failed&quot; : 21025,
  &quot;session_reuses&quot; : 15762
}
</code></pre>
<ul>
<li>
<p>与平板分配器共享的内存区域：</p>
</li>
<li>
<p><code>pages</code></p>
<ul>
<li>可用和已用内存页数。</li>
</ul>
</li>
<li>
<p><code>used</code> ( <code>integer</code> )</p>
<ul>
<li>
<p>当前已使用的内存页数。</p>
</li>
<li>
<p><code>free</code> ( <code>integer</code> )</p>
<ul>
<li>当前的可用内存页数。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>slots</code></p>
<ul>
<li>内存插槽的状态数据(8、16、32、64、128 等)</li>
</ul>
</li>
</ul>
<p>“ <a href="#def_nginx_slab_zone_slot">Memory Slot</a>”对象的集合</p>
<p>Example:</p>
<pre id="def_nginx_slab_zone"><code class="hljs language-shell" id="def_nginx_slab_zone">{
  &quot;pages&quot; : {
    &quot;used&quot; : 1143,
    &quot;free&quot; : 2928
  },
  &quot;slots&quot; : {
    &quot;8&quot; : {
      &quot;used&quot; : 0,
      &quot;free&quot; : 0,
      &quot;reqs&quot; : 0,
      &quot;fails&quot; : 0
    },
    &quot;16&quot; : {
      &quot;used&quot; : 0,
      &quot;free&quot; : 0,
      &quot;reqs&quot; : 0,
      &quot;fails&quot; : 0
    },
    &quot;32&quot; : {
      &quot;used&quot; : 0,
      &quot;free&quot; : 0,
      &quot;reqs&quot; : 0,
      &quot;fails&quot; : 0
    },
    &quot;64&quot; : {
      &quot;used&quot; : 1,
      &quot;free&quot; : 63,
      &quot;reqs&quot; : 1,
      &quot;fails&quot; : 0
    },
    &quot;128&quot; : {
      &quot;used&quot; : 0,
      &quot;free&quot; : 0,
      &quot;reqs&quot; : 0,
      &quot;fails&quot; : 0
    },
    &quot;256&quot; : {
      &quot;used&quot; : 18078,
      &quot;free&quot; : 178,
      &quot;reqs&quot; : 1635736,
      &quot;fails&quot; : 0
    }
  }
}
</code></pre>
<ul>
<li>
<p>Memory Slot:</p>
</li>
<li>
<p><code>used</code> ( <code>integer</code> )</p>
<ul>
<li>当前已用内存插槽的数量。</li>
</ul>
</li>
<li>
<p><code>free</code> ( <code>integer</code> )</p>
<ul>
<li>当前的可用内存插槽数。</li>
</ul>
</li>
<li>
<p><code>reqs</code> ( <code>integer</code> )</p>
<ul>
<li>分配指定大小的内存的总尝试次数。</li>
</ul>
</li>
<li>
<p><code>fails</code> ( <code>integer</code> )</p>
<ul>
<li id="def_nginx_slab_zone_slot">尝试分配指定大小的内存失败的次数。</li>
</ul>
</li>
<li>
<p>HTTP Requests:</p>
</li>
<li>
<p><code>total</code> ( <code>integer</code> )</p>
<ul>
<li>客户端请求总数。</li>
</ul>
</li>
<li>
<p><code>current</code> ( <code>integer</code> )</p>
<ul>
<li>当前的客户端请求数。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_http_requests"><code class="hljs language-shell" id="def_nginx_http_requests">{
  &quot;total&quot; : 10624511,
  &quot;current&quot; : 4
}
</code></pre>
<ul>
<li>
<p>HTTP 服务器区域：</p>
</li>
<li>
<p><code>processing</code> ( <code>integer</code> )</p>
<ul>
<li>当前正在处理的客户端请求数。</li>
</ul>
</li>
<li>
<p><code>requests</code> ( <code>integer</code> )</p>
<ul>
<li>从客户端收到的客户端请求总数。</li>
</ul>
</li>
<li>
<p><code>responses</code></p>
<ul>
<li>发送给客户端的响应总数，以及状态码为“ <code>1xx</code>”，“ <code>2xx</code>”，“ <code>3xx</code>”，“ <code>4xx</code>”和“ <code>5xx</code>”的响应的数量。</li>
</ul>
</li>
<li>
<p><code>1xx</code> ( <code>integer</code> )</p>
<ul>
<li>
<p>状态代码为“ <code>1xx</code>”的响应数。</p>
</li>
<li>
<p><code>2xx</code> ( <code>integer</code> )</p>
<ul>
<li>状态代码为“ <code>2xx</code>”的响应数。</li>
</ul>
</li>
<li>
<p><code>3xx</code> ( <code>integer</code> )</p>
<ul>
<li>状态代码为“ <code>3xx</code>”的响应数。</li>
</ul>
</li>
<li>
<p><code>4xx</code> ( <code>integer</code> )</p>
<ul>
<li>状态代码为“ <code>4xx</code>”的响应数。</li>
</ul>
</li>
<li>
<p><code>5xx</code> ( <code>integer</code> )</p>
<ul>
<li>状态代码为“ <code>5xx</code>”的响应数。</li>
</ul>
</li>
<li>
<p><code>total</code> ( <code>integer</code> )</p>
<ul>
<li>发送给客户的响应总数。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>discarded</code> ( <code>integer</code> )</p>
<ul>
<li>没有发送响应的已完成请求总数。</li>
</ul>
</li>
<li>
<p><code>received</code> ( <code>integer</code> )</p>
<ul>
<li>从客户端收到的字节总数。</li>
</ul>
</li>
<li>
<p><code>sent</code> ( <code>integer</code> )</p>
<ul>
<li>发送给客户端的字节总数。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_http_server_zone"><code class="hljs language-shell" id="def_nginx_http_server_zone">{
  &quot;processing&quot; : 1,
  &quot;requests&quot; : 706690,
  &quot;responses&quot; : {
    &quot;1xx&quot; : 0,
    &quot;2xx&quot; : 699482,
    &quot;3xx&quot; : 4522,
    &quot;4xx&quot; : 907,
    &quot;5xx&quot; : 266,
    &quot;total&quot; : 705177
  },
  &quot;discarded&quot; : 1513,
  &quot;received&quot; : 172711587,
  &quot;sent&quot; : 19415530115
}
</code></pre>
<ul>
<li>
<p>HTTP 位置区域：</p>
</li>
<li>
<p><code>requests</code> ( <code>integer</code> )</p>
<ul>
<li>从客户端收到的客户端请求总数。</li>
</ul>
</li>
<li>
<p><code>responses</code></p>
<ul>
<li>发送给客户端的响应总数，以及状态码为“ <code>1xx</code>”，“ <code>2xx</code>”，“ <code>3xx</code>”，“ <code>4xx</code>”和“ <code>5xx</code>”的响应的数量。</li>
</ul>
</li>
<li>
<p><code>1xx</code> ( <code>integer</code> )</p>
<ul>
<li>
<p>状态代码为“ <code>1xx</code>”的响应数。</p>
</li>
<li>
<p><code>2xx</code> ( <code>integer</code> )</p>
<ul>
<li>状态代码为“ <code>2xx</code>”的响应数。</li>
</ul>
</li>
<li>
<p><code>3xx</code> ( <code>integer</code> )</p>
<ul>
<li>状态代码为“ <code>3xx</code>”的响应数。</li>
</ul>
</li>
<li>
<p><code>4xx</code> ( <code>integer</code> )</p>
<ul>
<li>状态代码为“ <code>4xx</code>”的响应数。</li>
</ul>
</li>
<li>
<p><code>5xx</code> ( <code>integer</code> )</p>
<ul>
<li>状态代码为“ <code>5xx</code>”的响应数。</li>
</ul>
</li>
<li>
<p><code>total</code> ( <code>integer</code> )</p>
<ul>
<li>发送给客户的响应总数。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>discarded</code> ( <code>integer</code> )</p>
<ul>
<li>没有发送响应的已完成请求总数。</li>
</ul>
</li>
<li>
<p><code>received</code> ( <code>integer</code> )</p>
<ul>
<li>从客户端收到的字节总数。</li>
</ul>
</li>
<li>
<p><code>sent</code> ( <code>integer</code> )</p>
<ul>
<li>发送给客户端的字节总数。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_http_location_zone"><code class="hljs language-shell" id="def_nginx_http_location_zone">{
  &quot;requests&quot; : 706690,
  &quot;responses&quot; : {
    &quot;1xx&quot; : 0,
    &quot;2xx&quot; : 699482,
    &quot;3xx&quot; : 4522,
    &quot;4xx&quot; : 907,
    &quot;5xx&quot; : 266,
    &quot;total&quot; : 705177
  },
  &quot;discarded&quot; : 1513,
  &quot;received&quot; : 172711587,
  &quot;sent&quot; : 19415530115
}
</code></pre>
<ul>
<li>
<p>HTTP Cache:</p>
</li>
<li>
<p><code>size</code> ( <code>integer</code> )</p>
<ul>
<li>当前缓存的大小。</li>
</ul>
</li>
<li>
<p><code>max_size</code> ( <code>integer</code> )</p>
<ul>
<li>配置中指定的最大缓存大小限制。</li>
</ul>
</li>
<li>
<p><code>cold</code> ( <code>boolean</code> )</p>
<ul>
<li>一个布尔值，指示“缓存加载器”进程是否仍在将数据从磁盘加载到缓存中。</li>
</ul>
</li>
<li>
<p><code>hit</code></p>
<ul>
<li>
<ul>
<li>
<p><code>responses</code> ( <code>integer</code> )</p>
</li>
<li>
<p>从缓存中读取的<a href="http-ngx_http_proxy_module.html#proxy_cache_valid">valid</a>个响应总数。</p>
</li>
</ul>
</li>
<li>
<p><code>bytes</code> ( <code>integer</code> )</p>
<ul>
<li>从缓存读取的字节总数。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>stale</code></p>
<ul>
<li>
<ul>
<li>
<p><code>responses</code> ( <code>integer</code> )</p>
</li>
<li>
<p>从缓存中读取的过期响应总数(请参见<a href="http-ngx_http_proxy_module.html#proxy_cache_use_stale">proxy_cache_use_stale</a>和其他“ <code>*_cache_use_stale</code>”指令)。</p>
</li>
</ul>
</li>
<li>
<p><code>bytes</code> ( <code>integer</code> )</p>
<ul>
<li>从缓存读取的字节总数。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>updating</code></p>
<ul>
<li>
<ul>
<li>
<p><code>responses</code> ( <code>integer</code> )</p>
</li>
<li>
<p>在更新响应时从缓存读取的过期响应总数(请参见<a href="http-ngx_http_proxy_module.html#proxy_cache_use_stale_updating">proxy_cache_use_stale</a>和其他“ <code>*_cache_use_stale</code>”指令)。</p>
</li>
</ul>
</li>
<li>
<p><code>bytes</code> ( <code>integer</code> )</p>
<ul>
<li>从缓存读取的字节总数。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>revalidated</code></p>
<ul>
<li>
<ul>
<li>
<p><code>responses</code> ( <code>integer</code> )</p>
</li>
<li>
<p>从缓存读取的过期和重新验证的响应总数(请参阅<a href="http-ngx_http_proxy_module.html#proxy_cache_revalidate">proxy_cache_revalidate</a>和其他“ <code>*_cache_revalidate</code>”指令)。</p>
</li>
</ul>
</li>
<li>
<p><code>bytes</code> ( <code>integer</code> )</p>
<ul>
<li>从缓存读取的字节总数。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>miss</code></p>
<ul>
<li>
<ul>
<li>
<p><code>responses</code> ( <code>integer</code> )</p>
</li>
<li>
<p>在缓存中找不到的响应总数。</p>
</li>
</ul>
</li>
<li>
<p><code>bytes</code> ( <code>integer</code> )</p>
<ul>
<li>从代理服务器读取的字节总数。</li>
</ul>
</li>
<li>
<p><code>responses_written</code> ( <code>integer</code> )</p>
<ul>
<li>写入缓存的响应总数。</li>
</ul>
</li>
<li>
<p><code>bytes_written</code> ( <code>integer</code> )</p>
<ul>
<li>写入缓存的总字节数。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>expired</code></p>
<ul>
<li>
<ul>
<li>
<p><code>responses</code> ( <code>integer</code> )</p>
</li>
<li>
<p>未从缓存中获取的过期响应总数。</p>
</li>
</ul>
</li>
<li>
<p><code>bytes</code> ( <code>integer</code> )</p>
<ul>
<li>从代理服务器读取的字节总数。</li>
</ul>
</li>
<li>
<p><code>responses_written</code> ( <code>integer</code> )</p>
<ul>
<li>写入缓存的响应总数。</li>
</ul>
</li>
<li>
<p><code>bytes_written</code> ( <code>integer</code> )</p>
<ul>
<li>写入缓存的总字节数。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>bypass</code></p>
<ul>
<li>
<ul>
<li>
<p><code>responses</code> ( <code>integer</code> )</p>
</li>
<li>
<p>由于<a href="http-ngx_http_proxy_module.html#proxy_cache_bypass">proxy_cache_bypass</a>和其他“ <code>*_cache_bypass</code>”指令，未在缓存中查找的响应总数。</p>
</li>
</ul>
</li>
<li>
<p><code>bytes</code> ( <code>integer</code> )</p>
<ul>
<li>从代理服务器读取的字节总数。</li>
</ul>
</li>
<li>
<p><code>responses_written</code> ( <code>integer</code> )</p>
<ul>
<li>写入缓存的响应总数。</li>
</ul>
</li>
<li>
<p><code>bytes_written</code> ( <code>integer</code> )</p>
<ul>
<li>写入缓存的总字节数。</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_http_cache"><code class="hljs language-shell" id="def_nginx_http_cache">{
  &quot;size&quot; : 530915328,
  &quot;max_size&quot; : 536870912,
  &quot;cold&quot; : false,
  &quot;hit&quot; : {
    &quot;responses&quot; : 254032,
    &quot;bytes&quot; : 6685627875
  },
  &quot;stale&quot; : {
    &quot;responses&quot; : 0,
    &quot;bytes&quot; : 0
  },
  &quot;updating&quot; : {
    &quot;responses&quot; : 0,
    &quot;bytes&quot; : 0
  },
  &quot;revalidated&quot; : {
    &quot;responses&quot; : 0,
    &quot;bytes&quot; : 0
  },
  &quot;miss&quot; : {
    &quot;responses&quot; : 1619201,
    &quot;bytes&quot; : 53841943822
  },
  &quot;expired&quot; : {
    &quot;responses&quot; : 45859,
    &quot;bytes&quot; : 1656847080,
    &quot;responses_written&quot; : 44992,
    &quot;bytes_written&quot; : 1641825173
  },
  &quot;bypass&quot; : {
    &quot;responses&quot; : 200187,
    &quot;bytes&quot; : 5510647548,
    &quot;responses_written&quot; : 200173,
    &quot;bytes_written&quot; : 44992
  }
}
</code></pre>
<ul>
<li>
<p>HTTP 连接限制：</p>
</li>
<li>
<p><code>passed</code> ( <code>integer</code> )</p>
<ul>
<li>既没有限制也没有被视为限制的连接总数。</li>
</ul>
</li>
<li>
<p><code>rejected</code> ( <code>integer</code> )</p>
<ul>
<li>拒绝的连接总数。</li>
</ul>
</li>
<li>
<p><code>rejected_dry_run</code> ( <code>integer</code> )</p>
<ul>
<li>在<a href="http-ngx_http_limit_conn_module.html#limit_conn_dry_run">dry run</a>模式下被拒绝的连接总数。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_http_limit_conn_zone"><code class="hljs language-shell" id="def_nginx_http_limit_conn_zone">{
  &quot;passed&quot; : 15,
  &quot;rejected&quot; : 0,
  &quot;rejected_dry_run&quot; : 2
}
</code></pre>
<ul>
<li>
<p>HTTP 请求速率限制：</p>
</li>
<li>
<p><code>passed</code> ( <code>integer</code> )</p>
<ul>
<li>既不受限也不视为受限的请求总数。</li>
</ul>
</li>
<li>
<p><code>delayed</code> ( <code>integer</code> )</p>
<ul>
<li>延迟的请求总数。</li>
</ul>
</li>
<li>
<p><code>rejected</code> ( <code>integer</code> )</p>
<ul>
<li>被拒绝的请求总数。</li>
</ul>
</li>
<li>
<p><code>delayed_dry_run</code> ( <code>integer</code> )</p>
<ul>
<li>在<a href="http-ngx_http_limit_req_module.html#limit_req_dry_run">dry run</a>模式下延迟的请求总数。</li>
</ul>
</li>
<li>
<p><code>rejected_dry_run</code> ( <code>integer</code> )</p>
<ul>
<li>在<a href="http-ngx_http_limit_req_module.html#limit_req_dry_run">dry run</a>模式下被拒绝的请求总数。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_http_limit_req_zone"><code class="hljs language-shell" id="def_nginx_http_limit_req_zone">{
  &quot;passed&quot; : 15,
  &quot;delayed&quot; : 4,
  &quot;rejected&quot; : 0,
  &quot;delayed_dry_run&quot; : 1,
  &quot;rejected_dry_run&quot; : 2
}
</code></pre>
<ul>
<li>
<p>HTTP Upstream:</p>
</li>
<li>
<p><code>peers</code></p>
<ul>
<li>数组：</li>
</ul>
</li>
<li>
<p><code>id</code> ( <code>integer</code> )</p>
<ul>
<li>
<p>服务器的 ID。</p>
</li>
<li>
<p><code>server</code> ( <code>string</code> )</p>
<ul>
<li>服务器的<a href="http-ngx_http_upstream_module.html#server">address</a>。</li>
</ul>
</li>
<li>
<p><code>service</code> ( <code>string</code> )</p>
<ul>
<li><a href="http-ngx_http_upstream_module.html#service">server</a>指令的<a href="http-ngx_http_upstream_module.html#server">service</a>参数值。</li>
</ul>
</li>
<li>
<p><code>name</code> ( <code>string</code> )</p>
<ul>
<li><a href="http-ngx_http_upstream_module.html#server">server</a>指令中指定的服务器名称。</li>
</ul>
</li>
<li>
<p><code>backup</code> ( <code>boolean</code> )</p>
<ul>
<li>指示服务器是否为<a href="http-ngx_http_upstream_module.html#backup">backup</a>服务器的布尔值。</li>
</ul>
</li>
<li>
<p><code>weight</code> ( <code>integer</code> )</p>
<ul>
<li>服务器的<a href="http-ngx_http_upstream_module.html#weight">Weight</a>。</li>
</ul>
</li>
<li>
<p><code>state</code> ( <code>string</code> )</p>
<ul>
<li>当前状态，可以是“ <code>up</code>”，“ <code>draining</code>”，“ <code>down</code>”，“ <code>unavail</code>”，“ <code>checking</code>”和“ <code>unhealthy</code>”之一。</li>
</ul>
</li>
<li>
<p><code>active</code> ( <code>integer</code> )</p>
<ul>
<li>当前活动连接数。</li>
</ul>
</li>
<li>
<p><code>max_conns</code> ( <code>integer</code> )</p>
<ul>
<li>服务器的<a href="http-ngx_http_upstream_module.html#max_conns">max_conns</a>限制。</li>
</ul>
</li>
<li>
<p><code>requests</code> ( <code>integer</code> )</p>
<ul>
<li>转发到该服务器的客户端请求总数。</li>
</ul>
</li>
<li>
<p><code>responses</code></p>
<ul>
<li>
<ul>
<li>
<p><code>1xx</code> ( <code>integer</code> )</p>
</li>
<li>
<p>状态代码为“ <code>1xx</code>”的响应数。</p>
</li>
</ul>
</li>
<li>
<p><code>2xx</code> ( <code>integer</code> )</p>
<ul>
<li>状态代码为“ <code>2xx</code>”的响应数。</li>
</ul>
</li>
<li>
<p><code>3xx</code> ( <code>integer</code> )</p>
<ul>
<li>状态代码为“ <code>3xx</code>”的响应数。</li>
</ul>
</li>
<li>
<p><code>4xx</code> ( <code>integer</code> )</p>
<ul>
<li>状态代码为“ <code>4xx</code>”的响应数。</li>
</ul>
</li>
<li>
<p><code>5xx</code> ( <code>integer</code> )</p>
<ul>
<li>状态代码为“ <code>5xx</code>”的响应数。</li>
</ul>
</li>
<li>
<p><code>total</code> ( <code>integer</code> )</p>
<ul>
<li>从该服务器获得的响应总数。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>sent</code> ( <code>integer</code> )</p>
<ul>
<li>发送到此服务器的字节总数。</li>
</ul>
</li>
<li>
<p><code>received</code> ( <code>integer</code> )</p>
<ul>
<li>从该服务器接收的字节总数。</li>
</ul>
</li>
<li>
<p><code>fails</code> ( <code>integer</code> )</p>
<ul>
<li>与服务器通信失败的尝试总数。</li>
</ul>
</li>
<li>
<p><code>unavail</code> ( <code>integer</code> )</p>
<ul>
<li>由于未成功尝试的次数达到<a href="http-ngx_http_upstream_module.html#max_fails">max_fails</a>阈值，服务器对客户端请求(状态“ <code>unavail</code>”)不可用的次数。</li>
</ul>
</li>
<li>
<p><code>health_checks</code></p>
<ul>
<li>
<ul>
<li>
<p><code>checks</code> ( <code>integer</code> )</p>
</li>
<li>
<p>发出的<a href="http-ngx_http_upstream_hc_module.html#health_check">health check</a>个请求总数。</p>
</li>
</ul>
</li>
<li>
<p><code>fails</code> ( <code>integer</code> )</p>
<ul>
<li>运行状况检查失败的次数。</li>
</ul>
</li>
<li>
<p><code>unhealthy</code> ( <code>integer</code> )</p>
<ul>
<li>服务器不正常运行了多少次(状态“ <code>unhealthy</code>”)。</li>
</ul>
</li>
<li>
<p><code>last_passed</code> ( <code>boolean</code> )</p>
<ul>
<li>布尔值，指示上一次运行状况检查请求是否成功并且已通过<a href="http-ngx_http_upstream_hc_module.html#match">tests</a>。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>downtime</code> ( <code>integer</code> )</p>
<ul>
<li>服务器处于“ <code>unavail</code>”，“ <code>checking</code>”和“ <code>unhealthy</code>”状态的总时间。</li>
</ul>
</li>
<li>
<p><code>downstart</code> ( <code>string</code> )</p>
<ul>
<li>服务器以 ISO 8601 格式(毫秒分辨率)成为“ <code>unavail</code>”，“ <code>checking</code>”或“ <code>unhealthy</code>”的时间。</li>
</ul>
</li>
<li>
<p><code>selected</code> ( <code>string</code> )</p>
<ul>
<li>上次选择服务器处理请求的时间，ISO 8601 格式，毫秒级分辨率。</li>
</ul>
</li>
<li>
<p><code>header_time</code> ( <code>integer</code> )</p>
<ul>
<li>从服务器获取<a href="http-ngx_http_upstream_module.html#var_upstream_header_time">response header</a>的平均时间。</li>
</ul>
</li>
<li>
<p><code>response_time</code> ( <code>integer</code> )</p>
<ul>
<li>从服务器获取<a href="http-ngx_http_upstream_module.html#var_upstream_response_time">full response</a>的平均时间。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>keepalive</code> ( <code>integer</code> )</p>
<ul>
<li>当前空闲的<a href="http-ngx_http_upstream_module.html#keepalive">keepalive</a>连接数。</li>
</ul>
</li>
<li>
<p><code>zombies</code> ( <code>integer</code> )</p>
<ul>
<li>当前从组中删除但仍在处理活动客户端请求的服务器数。</li>
</ul>
</li>
<li>
<p><code>zone</code> ( <code>string</code> )</p>
<ul>
<li>保留组的配置和运行时状态的共享内存<a href="http-ngx_http_upstream_module.html#zone">zone</a>的名称。</li>
</ul>
</li>
<li>
<p><code>queue</code></p>
<ul>
<li>对于请求<a href="http-ngx_http_upstream_module.html#queue">queue</a>，提供了以下数据：</li>
</ul>
</li>
<li>
<p><code>size</code> ( <code>integer</code> )</p>
<ul>
<li>
<p>队列中的当前请求数。</p>
</li>
<li>
<p><code>max_size</code> ( <code>integer</code> )</p>
<ul>
<li>可以同时在队列中的最大请求数。</li>
</ul>
</li>
<li>
<p><code>overflows</code> ( <code>integer</code> )</p>
<ul>
<li>由于队列溢出而被拒绝的请求总数。</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_http_upstream"><code class="hljs language-shell" id="def_nginx_http_upstream">{
  &quot;upstream_backend&quot; : {
    &quot;peers&quot; : [
      {
        &quot;id&quot; : 0,
        &quot;server&quot; : &quot;10.0.0.1:8088&quot;,
        &quot;name&quot; : &quot;10.0.0.1:8088&quot;,
        &quot;backup&quot; : false,
        &quot;weight&quot; : 5,
        &quot;state&quot; : &quot;up&quot;,
        &quot;active&quot; : 0,
        &quot;max_conns&quot; : 20,
        &quot;requests&quot; : 667231,
        &quot;header_time&quot; : 20,
        &quot;response_time&quot; : 36,
        &quot;responses&quot; : {
          &quot;1xx&quot; : 0,
          &quot;2xx&quot; : 666310,
          &quot;3xx&quot; : 0,
          &quot;4xx&quot; : 915,
          &quot;5xx&quot; : 6,
          &quot;total&quot; : 667231
        },
        &quot;sent&quot; : 251946292,
        &quot;received&quot; : 19222475454,
        &quot;fails&quot; : 0,
        &quot;unavail&quot; : 0,
        &quot;health_checks&quot; : {
          &quot;checks&quot; : 26214,
          &quot;fails&quot; : 0,
          &quot;unhealthy&quot; : 0,
          &quot;last_passed&quot; : true
        },
        &quot;downtime&quot; : 0,
        &quot;downstart&quot; : &quot;2019-10-01T11:09:21.602Z&quot;,
        &quot;selected&quot; : &quot;2019-10-01T15:01:25.000Z&quot;
      },
      {
        &quot;id&quot; : 1,
        &quot;server&quot; : &quot;10.0.0.1:8089&quot;,
        &quot;name&quot; : &quot;10.0.0.1:8089&quot;,
        &quot;backup&quot; : true,
        &quot;weight&quot; : 1,
        &quot;state&quot; : &quot;unhealthy&quot;,
        &quot;active&quot; : 0,
        &quot;max_conns&quot; : 20,
        &quot;requests&quot; : 0,
        &quot;responses&quot; : {
          &quot;1xx&quot; : 0,
          &quot;2xx&quot; : 0,
          &quot;3xx&quot; : 0,
          &quot;4xx&quot; : 0,
          &quot;5xx&quot; : 0,
          &quot;total&quot; : 0
        },
        &quot;sent&quot; : 0,
        &quot;received&quot; : 0,
        &quot;fails&quot; : 0,
        &quot;unavail&quot; : 0,
        &quot;health_checks&quot; : {
          &quot;checks&quot; : 26284,
          &quot;fails&quot; : 26284,
          &quot;unhealthy&quot; : 1,
          &quot;last_passed&quot; : false
        },
        &quot;downtime&quot; : 262925617,
        &quot;downstart&quot; : &quot;2019-10-01T11:09:21.602Z&quot;,
        &quot;selected&quot; : &quot;2019-10-01T15:01:25.000Z&quot;
      }
    ],
    &quot;keepalive&quot; : 0,
    &quot;zombies&quot; : 0,
    &quot;zone&quot; : &quot;upstream_backend&quot;
  }
}
</code></pre>
<ul>
<li>HTTP 上游服务器：</li>
</ul>
<p>HTTP 上游<a href="http-ngx_http_upstream_module.html#server">server</a>的动态可配置参数：</p>
<ul>
<li>
<p><code>id</code> ( <code>integer</code> )</p>
<ul>
<li>HTTP 上游服务器的 ID。 ID 是自动分配的，无法更改。</li>
</ul>
</li>
<li>
<p><code>server</code> ( <code>string</code> )</p>
<ul>
<li>与 HTTP 上游服务器的<a href="http-ngx_http_upstream_module.html#address">address</a>参数相同。添加服务器时，可以将其指定为域名。在这种情况下，将监视与域名对应的 IP 地址的更改，并将其自动应用于上游配置，而无需重新启动 nginx。这需要在“ <code>http</code>”块中使用<a href="http-ngx_http_core_module.html#resolver">resolver</a>指令。另请参见 HTTP 上游服务器的<a href="http-ngx_http_upstream_module.html#resolve">resolve</a>参数。</li>
</ul>
</li>
<li>
<p><code>service</code> ( <code>string</code> )</p>
<ul>
<li>与 HTTP 上游服务器的<a href="http-ngx_http_upstream_module.html#service">service</a>参数相同。此参数无法更改。</li>
</ul>
</li>
<li>
<p><code>weight</code> ( <code>integer</code> )</p>
<ul>
<li>与 HTTP 上游服务器的<a href="http-ngx_http_upstream_module.html#weight">weight</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>max_conns</code> ( <code>integer</code> )</p>
<ul>
<li>与 HTTP 上游服务器的<a href="http-ngx_http_upstream_module.html#max_conns">max_conns</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>max_fails</code> ( <code>integer</code> )</p>
<ul>
<li>与 HTTP 上游服务器的<a href="http-ngx_http_upstream_module.html#max_fails">max_fails</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>fail_timeout</code> ( <code>string</code> )</p>
<ul>
<li>与 HTTP 上游服务器的<a href="http-ngx_http_upstream_module.html#fail_timeout">fail_timeout</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>slow_start</code> ( <code>string</code> )</p>
<ul>
<li>与 HTTP 上游服务器的<a href="http-ngx_http_upstream_module.html#slow_start">slow_start</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>route</code> ( <code>string</code> )</p>
<ul>
<li>与 HTTP 上游服务器的<a href="http-ngx_http_upstream_module.html#route">route</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>backup</code> ( <code>boolean</code> )</p>
<ul>
<li>当<code>true</code>时，添加一个<a href="http-ngx_http_upstream_module.html#backup">backup</a>服务器。此参数无法更改。</li>
</ul>
</li>
<li>
<p><code>down</code> ( <code>boolean</code> )</p>
<ul>
<li>与 HTTP 上游服务器的<a href="http-ngx_http_upstream_module.html#down">down</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>drain</code> ( <code>boolean</code> )</p>
<ul>
<li>与 HTTP 上游服务器的<a href="http-ngx_http_upstream_module.html#drain">drain</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>parent</code> ( <code>string</code> )</p>
<ul>
<li>解析服务器的父服务器 ID。 ID 是自动分配的，无法更改。</li>
</ul>
</li>
<li>
<p><code>host</code> ( <code>string</code> )</p>
<ul>
<li>解析服务器的主机名。主机名是自动分配的，不能更改。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_http_upstream_conf_server"><code class="hljs language-shell" id="def_nginx_http_upstream_conf_server">{
  &quot;id&quot; : 1,
  &quot;server&quot; : &quot;10.0.0.1:8089&quot;,
  &quot;weight&quot; : 4,
  &quot;max_conns&quot; : 0,
  &quot;max_fails&quot; : 0,
  &quot;fail_timeout&quot; : &quot;10s&quot;,
  &quot;slow_start&quot; : &quot;10s&quot;,
  &quot;route&quot; : &quot;&quot;,
  &quot;backup&quot; : true,
  &quot;down&quot; : true
}
</code></pre>
<ul>
<li>HTTP 密钥共享存储区：</li>
</ul>
<p>使用 GET 方法时，HTTP keyval 共享内存区域的内容。</p>
<p>Example:</p>
<pre id="def_nginx_http_keyval_zone"><code class="hljs language-shell" id="def_nginx_http_keyval_zone">{
  &quot;key1&quot; : &quot;value1&quot;,
  &quot;key2&quot; : &quot;value2&quot;,
  &quot;key3&quot; : &quot;value3&quot;
}
</code></pre>
<ul>
<li>HTTP 密钥共享存储区：</li>
</ul>
<p>使用 POST 或 PATCH 方法时，HTTP keyval 共享内存区域的内容。</p>
<p>Example:</p>
<pre id="def_nginx_http_keyval_zone_post_patch"><code class="hljs language-shell" id="def_nginx_http_keyval_zone_post_patch">{
  &quot;key1&quot; : &quot;value1&quot;,
  &quot;key2&quot; : &quot;value2&quot;,
  &quot;key3&quot; : {
    &quot;value&quot; : &quot;value3&quot;,
    &quot;expire&quot; : 30000
  }
}
</code></pre>
<ul>
<li>
<p>流服务器区域：</p>
</li>
<li>
<p><code>processing</code> ( <code>integer</code> )</p>
<ul>
<li>当前正在处理的客户端连接数。</li>
</ul>
</li>
<li>
<p><code>connections</code> ( <code>integer</code> )</p>
<ul>
<li>客户端接受的连接总数。</li>
</ul>
</li>
<li>
<p><code>sessions</code></p>
<ul>
<li>已完成的会话总数，以及以状态代码“ <code>2xx</code>”，“ <code>4xx</code>”或“ <code>5xx</code>”完成的会话数。</li>
</ul>
</li>
<li>
<p><code>2xx</code> ( <code>integer</code> )</p>
<ul>
<li>
<p>以<a href="stream-ngx_stream_core_module.html#var_status">status codes</a>“ <code>2xx</code>”完成的会话总数。</p>
</li>
<li>
<p><code>4xx</code> ( <code>integer</code> )</p>
<ul>
<li>以<a href="stream-ngx_stream_core_module.html#var_status">status codes</a>“ <code>4xx</code>”完成的会话总数。</li>
</ul>
</li>
<li>
<p><code>5xx</code> ( <code>integer</code> )</p>
<ul>
<li>以<a href="stream-ngx_stream_core_module.html#var_status">status codes</a>“ <code>5xx</code>”完成的会话总数。</li>
</ul>
</li>
<li>
<p><code>total</code> ( <code>integer</code> )</p>
<ul>
<li>完成的客户会话总数。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>discarded</code> ( <code>integer</code> )</p>
<ul>
<li>不创建会话而完成的连接总数。</li>
</ul>
</li>
<li>
<p><code>received</code> ( <code>integer</code> )</p>
<ul>
<li>从客户端收到的字节总数。</li>
</ul>
</li>
<li>
<p><code>sent</code> ( <code>integer</code> )</p>
<ul>
<li>发送给客户端的字节总数。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_stream_server_zone"><code class="hljs language-shell" id="def_nginx_stream_server_zone">{
  &quot;dns&quot; : {
    &quot;processing&quot; : 1,
    &quot;connections&quot; : 155569,
    &quot;sessions&quot; : {
      &quot;2xx&quot; : 155564,
      &quot;4xx&quot; : 0,
      &quot;5xx&quot; : 0,
      &quot;total&quot; : 155569
    },
    &quot;discarded&quot; : 0,
    &quot;received&quot; : 4200363,
    &quot;sent&quot; : 20489184
  }
}
</code></pre>
<ul>
<li>
<p>流连接限制：</p>
</li>
<li>
<p><code>passed</code> ( <code>integer</code> )</p>
<ul>
<li>既没有限制也没有被视为限制的连接总数。</li>
</ul>
</li>
<li>
<p><code>rejected</code> ( <code>integer</code> )</p>
<ul>
<li>拒绝的连接总数。</li>
</ul>
</li>
<li>
<p><code>rejected_dry_run</code> ( <code>integer</code> )</p>
<ul>
<li>在<a href="stream-ngx_stream_limit_conn_module.html#limit_conn_dry_run">dry run</a>模式下被拒绝的连接总数。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_stream_limit_conn_zone"><code class="hljs language-shell" id="def_nginx_stream_limit_conn_zone">{
  &quot;passed&quot; : 15,
  &quot;rejected&quot; : 0,
  &quot;rejected_dry_run&quot; : 2
}
</code></pre>
<ul>
<li>
<p>Stream Upstream:</p>
</li>
<li>
<p><code>peers</code></p>
<ul>
<li>数组：</li>
</ul>
</li>
<li>
<p><code>id</code> ( <code>integer</code> )</p>
<ul>
<li>
<p>服务器的 ID。</p>
</li>
<li>
<p><code>server</code> ( <code>string</code> )</p>
<ul>
<li>服务器的<a href="stream-ngx_stream_upstream_module.html#server">address</a>。</li>
</ul>
</li>
<li>
<p><code>service</code> ( <code>string</code> )</p>
<ul>
<li><a href="stream-ngx_stream_upstream_module.html#service">server</a>指令的<a href="stream-ngx_stream_upstream_module.html#server">service</a>参数值。</li>
</ul>
</li>
<li>
<p><code>name</code> ( <code>string</code> )</p>
<ul>
<li><a href="stream-ngx_stream_upstream_module.html#server">server</a>指令中指定的服务器名称。</li>
</ul>
</li>
<li>
<p><code>backup</code> ( <code>boolean</code> )</p>
<ul>
<li>指示服务器是否为<a href="stream-ngx_stream_upstream_module.html#backup">backup</a>服务器的布尔值。</li>
</ul>
</li>
<li>
<p><code>weight</code> ( <code>integer</code> )</p>
<ul>
<li>服务器的<a href="stream-ngx_stream_upstream_module.html#weight">Weight</a>。</li>
</ul>
</li>
<li>
<p><code>state</code> ( <code>string</code> )</p>
<ul>
<li>当前状态，可以是“ <code>up</code>”，“ <code>down</code>”，“ <code>unavail</code>”，“ <code>checking</code>”或“ <code>unhealthy</code>”之一。</li>
</ul>
</li>
<li>
<p><code>active</code> ( <code>integer</code> )</p>
<ul>
<li>当前的连接数。</li>
</ul>
</li>
<li>
<p><code>max_conns</code> ( <code>integer</code> )</p>
<ul>
<li>服务器的<a href="stream-ngx_stream_upstream_module.html#max_conns">max_conns</a>限制。</li>
</ul>
</li>
<li>
<p><code>connections</code> ( <code>integer</code> )</p>
<ul>
<li>转发到该服务器的客户端连接总数。</li>
</ul>
</li>
<li>
<p><code>connect_time</code> ( <code>integer</code> )</p>
<ul>
<li>连接到上游服务器的平均时间。</li>
</ul>
</li>
<li>
<p><code>first_byte_time</code> ( <code>integer</code> )</p>
<ul>
<li>接收数据第一个字节的平均时间。</li>
</ul>
</li>
<li>
<p><code>response_time</code> ( <code>integer</code> )</p>
<ul>
<li>接收数据最后一个字节的平均时间。</li>
</ul>
</li>
<li>
<p><code>sent</code> ( <code>integer</code> )</p>
<ul>
<li>发送到此服务器的字节总数。</li>
</ul>
</li>
<li>
<p><code>received</code> ( <code>integer</code> )</p>
<ul>
<li>从该服务器接收的字节总数。</li>
</ul>
</li>
<li>
<p><code>fails</code> ( <code>integer</code> )</p>
<ul>
<li>与服务器通信失败的尝试总数。</li>
</ul>
</li>
<li>
<p><code>unavail</code> ( <code>integer</code> )</p>
<ul>
<li>由于未成功尝试达到<a href="stream-ngx_stream_upstream_module.html#max_fails">max_fails</a>阈值的次数，服务器无法连接客户端连接(状态“ <code>unavail</code>”)的次数。</li>
</ul>
</li>
<li>
<p><code>health_checks</code></p>
<ul>
<li>
<ul>
<li>
<p><code>checks</code> ( <code>integer</code> )</p>
</li>
<li>
<p>发出的<a href="stream-ngx_stream_upstream_hc_module.html#health_check">health check</a>个请求总数。</p>
</li>
</ul>
</li>
<li>
<p><code>fails</code> ( <code>integer</code> )</p>
<ul>
<li>运行状况检查失败的次数。</li>
</ul>
</li>
<li>
<p><code>unhealthy</code> ( <code>integer</code> )</p>
<ul>
<li>服务器不正常运行了多少次(状态“ <code>unhealthy</code>”)。</li>
</ul>
</li>
<li>
<p><code>last_passed</code> ( <code>boolean</code> )</p>
<ul>
<li>指示上一次运行状况检查请求是否成功并通过<a href="stream-ngx_stream_upstream_hc_module.html#match">tests</a>的布尔值。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>downtime</code> ( <code>integer</code> )</p>
<ul>
<li>服务器处于“ <code>unavail</code>”，“ <code>checking</code>”和“ <code>unhealthy</code>”状态的总时间。</li>
</ul>
</li>
<li>
<p><code>downstart</code> ( <code>string</code> )</p>
<ul>
<li>服务器以 ISO 8601 格式(毫秒分辨率)成为“ <code>unavail</code>”，“ <code>checking</code>”或“ <code>unhealthy</code>”的时间。</li>
</ul>
</li>
<li>
<p><code>selected</code> ( <code>string</code> )</p>
<ul>
<li>上次选择服务器处理连接的时间，ISO 8601 格式，毫秒级分辨率。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>zombies</code> ( <code>integer</code> )</p>
<ul>
<li>当前从组中删除的服务器数量，但仍在处理活动的客户端连接。</li>
</ul>
</li>
<li>
<p><code>zone</code> ( <code>string</code> )</p>
<ul>
<li>保留组的配置和运行时状态的共享内存<a href="stream-ngx_stream_upstream_module.html#zone">zone</a>的名称。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_stream_upstream"><code class="hljs language-shell" id="def_nginx_stream_upstream">{
  &quot;dns&quot; : {
    &quot;peers&quot; : [
      {
        &quot;id&quot; : 0,
        &quot;server&quot; : &quot;10.0.0.1:12347&quot;,
        &quot;name&quot; : &quot;10.0.0.1:12347&quot;,
        &quot;backup&quot; : false,
        &quot;weight&quot; : 5,
        &quot;state&quot; : &quot;up&quot;,
        &quot;active&quot; : 0,
        &quot;max_conns&quot; : 50,
        &quot;connections&quot; : 667231,
        &quot;sent&quot; : 251946292,
        &quot;received&quot; : 19222475454,
        &quot;fails&quot; : 0,
        &quot;unavail&quot; : 0,
        &quot;health_checks&quot; : {
          &quot;checks&quot; : 26214,
          &quot;fails&quot; : 0,
          &quot;unhealthy&quot; : 0,
          &quot;last_passed&quot; : true
        },
        &quot;downtime&quot; : 0,
        &quot;downstart&quot; : &quot;2019-10-01T11:09:21.602Z&quot;,
        &quot;selected&quot; : &quot;2019-10-01T15:01:25.000Z&quot;
      },
      {
        &quot;id&quot; : 1,
        &quot;server&quot; : &quot;10.0.0.1:12348&quot;,
        &quot;name&quot; : &quot;10.0.0.1:12348&quot;,
        &quot;backup&quot; : true,
        &quot;weight&quot; : 1,
        &quot;state&quot; : &quot;unhealthy&quot;,
        &quot;active&quot; : 0,
        &quot;max_conns&quot; : 50,
        &quot;connections&quot; : 0,
        &quot;sent&quot; : 0,
        &quot;received&quot; : 0,
        &quot;fails&quot; : 0,
        &quot;unavail&quot; : 0,
        &quot;health_checks&quot; : {
          &quot;checks&quot; : 26284,
          &quot;fails&quot; : 26284,
          &quot;unhealthy&quot; : 1,
          &quot;last_passed&quot; : false
        },
        &quot;downtime&quot; : 262925617,
        &quot;downstart&quot; : &quot;2019-10-01T11:09:21.602Z&quot;,
        &quot;selected&quot; : &quot;2019-10-01T15:01:25.000Z&quot;
      }
    ],
    &quot;zombies&quot; : 0,
    &quot;zone&quot; : &quot;dns&quot;
  }
}
</code></pre>
<ul>
<li>流上游服务器：</li>
</ul>
<p>上游<a href="stream-ngx_stream_upstream_module.html#server">server</a>的流的动态可配置参数：</p>
<ul>
<li>
<p><code>id</code> ( <code>integer</code> )</p>
<ul>
<li>流上游服务器的 ID。 ID 是自动分配的，无法更改。</li>
</ul>
</li>
<li>
<p><code>server</code> ( <code>string</code> )</p>
<ul>
<li>与流上游服务器的<a href="stream-ngx_stream_upstream_module.html#server">address</a>参数相同。添加服务器时，可以将其指定为域名。在这种情况下，将监视与域名对应的 IP 地址的更改，并将其自动应用于上游配置，而无需重新启动 nginx。这需要在“ <code>stream</code>”块中使用<a href="stream-ngx_stream_core_module.html#resolver">resolver</a>指令。另请参见流上游服务器的<a href="stream-ngx_stream_upstream_module.html#resolve">resolve</a>参数。</li>
</ul>
</li>
<li>
<p><code>service</code> ( <code>string</code> )</p>
<ul>
<li>与流上游服务器的<a href="stream-ngx_stream_upstream_module.html#service">service</a>参数相同。此参数无法更改。</li>
</ul>
</li>
<li>
<p><code>weight</code> ( <code>integer</code> )</p>
<ul>
<li>与流上游服务器的<a href="stream-ngx_stream_upstream_module.html#weight">weight</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>max_conns</code> ( <code>integer</code> )</p>
<ul>
<li>与流上游服务器的<a href="stream-ngx_stream_upstream_module.html#max_conns">max_conns</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>max_fails</code> ( <code>integer</code> )</p>
<ul>
<li>与流上游服务器的<a href="stream-ngx_stream_upstream_module.html#max_fails">max_fails</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>fail_timeout</code> ( <code>string</code> )</p>
<ul>
<li>与流上游服务器的<a href="stream-ngx_stream_upstream_module.html#fail_timeout">fail_timeout</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>slow_start</code> ( <code>string</code> )</p>
<ul>
<li>与流上游服务器的<a href="stream-ngx_stream_upstream_module.html#slow_start">slow_start</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>backup</code> ( <code>boolean</code> )</p>
<ul>
<li>当<code>true</code>时，添加一个<a href="stream-ngx_stream_upstream_module.html#backup">backup</a>服务器。此参数无法更改。</li>
</ul>
</li>
<li>
<p><code>down</code> ( <code>boolean</code> )</p>
<ul>
<li>与流上游服务器的<a href="stream-ngx_stream_upstream_module.html#down">down</a>参数相同。</li>
</ul>
</li>
<li>
<p><code>parent</code> ( <code>string</code> )</p>
<ul>
<li>解析服务器的父服务器 ID。 ID 是自动分配的，无法更改。</li>
</ul>
</li>
<li>
<p><code>host</code> ( <code>string</code> )</p>
<ul>
<li>解析服务器的主机名。主机名是自动分配的，不能更改。</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_stream_upstream_conf_server"><code class="hljs language-shell" id="def_nginx_stream_upstream_conf_server">{
  &quot;id&quot; : 0,
  &quot;server&quot; : &quot;10.0.0.1:12348&quot;,
  &quot;weight&quot; : 1,
  &quot;max_conns&quot; : 0,
  &quot;max_fails&quot; : 1,
  &quot;fail_timeout&quot; : &quot;10s&quot;,
  &quot;slow_start&quot; : 0,
  &quot;backup&quot; : false,
  &quot;down&quot; : false
}
</code></pre>
<ul>
<li>流密钥共享存储区：</li>
</ul>
<p>使用 GET 方法时，流 keyval 共享内存区域的内容。</p>
<p>Example:</p>
<pre id="def_nginx_stream_keyval_zone"><code class="hljs language-shell" id="def_nginx_stream_keyval_zone">{
  &quot;key1&quot; : &quot;value1&quot;,
  &quot;key2&quot; : &quot;value2&quot;,
  &quot;key3&quot; : &quot;value3&quot;
}
</code></pre>
<ul>
<li>流密钥共享存储区：</li>
</ul>
<p>使用 POST 或 PATCH 方法时，流密钥共享存储区的内容。</p>
<p>Example:</p>
<pre id="def_nginx_stream_keyval_zone_post_patch"><code class="hljs language-shell" id="def_nginx_stream_keyval_zone_post_patch">{
  &quot;key1&quot; : &quot;value1&quot;,
  &quot;key2&quot; : &quot;value2&quot;,
  &quot;key3&quot; : {
    &quot;value&quot; : &quot;value3&quot;,
    &quot;expire&quot; : 30000
  }
}
</code></pre>
<ul>
<li>
<p>流区同步节点：</p>
</li>
<li>
<p><code>zones</code></p>
<ul>
<li>每个共享内存区域的同步信息。</li>
</ul>
</li>
</ul>
<p>“ <a href="#def_nginx_stream_zone_sync_zone">Sync Zone</a>”对象的集合</p>
<ul>
<li>
<p><code>status</code></p>
<ul>
<li>集群中每个节点的同步信息。</li>
</ul>
</li>
<li>
<p><code>bytes_in</code> ( <code>integer</code> )</p>
<ul>
<li>
<p>该节点接收的字节数。</p>
</li>
<li>
<p><code>msgs_in</code> ( <code>integer</code> )</p>
<ul>
<li>该节点接收到的消息数。</li>
</ul>
</li>
<li>
<p><code>msgs_out</code> ( <code>integer</code> )</p>
<ul>
<li>该节点发送的消息数。</li>
</ul>
</li>
<li>
<p><code>bytes_out</code> ( <code>integer</code> )</p>
<ul>
<li>此节点发送的字节数。</li>
</ul>
</li>
<li>
<p><code>nodes_online</code> ( <code>integer</code> )</p>
<ul>
<li>该节点连接的对等体数。</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_stream_zone_sync"><code class="hljs language-shell" id="def_nginx_stream_zone_sync">{
  &quot;zones&quot; : {
    &quot;zone1&quot; : {
      &quot;records_pending&quot; : 2061,
      &quot;records_total&quot; : 260575
    },
    &quot;zone2&quot; : {
      &quot;records_pending&quot; : 0,
      &quot;records_total&quot; : 14749
    }
  },
  &quot;status&quot; : {
    &quot;bytes_in&quot; : 1364923761,
    &quot;msgs_in&quot; : 337236,
    &quot;msgs_out&quot; : 346717,
    &quot;bytes_out&quot; : 1402765472,
    &quot;nodes_online&quot; : 15
  }
}
</code></pre>
<ul>
<li>Sync Zone:</li>
</ul>
<p>共享内存区域的同步状态。</p>
<ul>
<li>
<p><code>records_pending</code> ( <code>integer</code> )</p>
<ul>
<li>需要发送到集群的记录数。</li>
</ul>
</li>
<li>
<p><code>records_total</code> ( <code>integer</code> )</p>
<ul>
<li id="def_nginx_stream_zone_sync_zone">共享存储区中存储的记录总数。</li>
</ul>
</li>
<li>
<p>Resolver Zone:</p>
</li>
</ul>
<p>每个特定<a href="http-ngx_http_core_module.html#resolver_status_zone">resolver zone</a>的 DNS 请求和响应的统计信息。</p>
<ul>
<li>
<p><code>requests</code></p>
<ul>
<li>
<ul>
<li>
<p><code>name</code> ( <code>integer</code> )</p>
</li>
<li>
<p>将名称解析为地址的请求总数。</p>
</li>
</ul>
</li>
<li>
<p><code>srv</code> ( <code>integer</code> )</p>
<ul>
<li>解析 SRV 记录的请求总数。</li>
</ul>
</li>
<li>
<p><code>addr</code> ( <code>integer</code> )</p>
<ul>
<li>将地址解析为名称的请求总数。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>responses</code></p>
<ul>
<li>
<ul>
<li>
<p><code>noerror</code> ( <code>integer</code> )</p>
</li>
<li>
<p>成功响应的总数。</p>
</li>
</ul>
</li>
<li>
<p><code>formerr</code> ( <code>integer</code> )</p>
<ul>
<li>FORMERR(<code>Format error</code>)响应的总数。</li>
</ul>
</li>
<li>
<p><code>servfail</code> ( <code>integer</code> )</p>
<ul>
<li>SERVFAIL(<code>Server failure</code>)响应的总数。</li>
</ul>
</li>
<li>
<p><code>nxdomain</code> ( <code>integer</code> )</p>
<ul>
<li>NXDOMAIN(<code>Host not found</code>)响应的总数。</li>
</ul>
</li>
<li>
<p><code>notimp</code> ( <code>integer</code> )</p>
<ul>
<li>NOTIMP(<code>Unimplemented</code>)响应的总数。</li>
</ul>
</li>
<li>
<p><code>refused</code> ( <code>integer</code> )</p>
<ul>
<li>REFUSED(<code>Operation refused</code>)个响应的总数。</li>
</ul>
</li>
<li>
<p><code>timedout</code> ( <code>integer</code> )</p>
<ul>
<li>超时请求总数。</li>
</ul>
</li>
<li>
<p><code>unknown</code> ( <code>integer</code> )</p>
<ul>
<li>发生未知错误的请求总数。</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>Example:</p>
<pre id="def_nginx_resolver_zone"><code class="hljs language-shell" id="def_nginx_resolver_zone">{
  &quot;resolver_zone1&quot; : {
    &quot;requests&quot; : {
      &quot;name&quot; : 25460,
      &quot;srv&quot; : 130,
      &quot;addr&quot; : 2580
    },
    &quot;responses&quot; : {
      &quot;noerror&quot; : 26499,
      &quot;formerr&quot; : 0,
      &quot;servfail&quot; : 3,
      &quot;nxdomain&quot; : 0,
      &quot;notimp&quot; : 0,
      &quot;refused&quot; : 0,
      &quot;timedout&quot; : 243,
      &quot;unknown&quot; : 478
    }
  }
}
</code></pre>
<ul>
<li>Error:</li>
</ul>
<p>nginx 错误对象。</p>
<ul>
<li>
<p><code>error</code></p>
<ul>
<li>
<ul>
<li>
<p><code>status</code> ( <code>integer</code> )</p>
</li>
<li>
<p>HTTP 错误代码。</p>
</li>
</ul>
</li>
<li>
<p><code>text</code> ( <code>string</code> )</p>
<ul>
<li>Error description.</li>
</ul>
</li>
<li>
<p><code>code</code> ( <code>string</code> )</p>
<ul>
<li>内部 Nginx 错误代码。</li>
</ul>
</li>
</ul>
</li>
<li>
<p><code>request_id</code> ( <code>string</code> )</p>
<ul>
<li>请求的 ID 等于<a href="http-ngx_http_core_module.html#var_request_id">$request_id</a>变量的值。</li>
</ul>
</li>
<li>
<p><code>href</code> ( <code>string</code> )</p>
<ul>
<li id="def_nginx_error">链接到参考文档。</li>
</ul>
</li>
</ul>
</div>
</div>
</section>
<div class="right-sidebar">
<div class="affix"><ins class="adsbygoogle" style="display:block" data-ad-client="ca-pub-6108808167664152" data-ad-slot="3102929424" data-ad-format="auto" data-full-width-responsive="true"></ins>
<script>
     (adsbygoogle = window.adsbygoogle || []).push({});
</script></div>
</div>
</div>
<div class="ft">
<a href="#toolbar-title" id="anchorNavigationExGoTop"><i class="fa fa-arrow-up"></i></a>
<footer class="footer">
<div class="footer__container--normal">
<img alt="扫码关注公众号" title="扫码关注公众号" src="static/picture/qr-code.png" width="170" height="170">
<div class="footer__description--normal">
<p class="paragraph footer__author--normal">Docs4dev<sup class="super">&#xAE;</sup>
</p>
<p class="paragraph footer__quote&#45;&#45;normal">
如果你在使用过程中遇到任何问题，可以在 <a href="javascript:window.open('https://github.com/docs4dev/docs4dev-issues');" target="_blank" rel="noopener noreferrer">这里<i class="fa fa-external-link"></i></a> 提issue。
</p>
<div class="footer__main--normal">
<p class="paragraph footer__main__paragraph--normal copyright" style="color: #666 !important;">
<a href="javascript:window.open('https://beian.miit.gov.cn/');">
蜀ICP备14021783号-6
</a>
</p>
<p class="paragraph footer__main__paragraph--normal copyright" style="color: #666 !important;">
Copyright &#xA9; Docs4dev all
right reserved, powered by <a href="index2.html" target="_blank">Docs4dev</a></p>
</div>
</div>
</div>
<div class="box__issues">
</div>
</footer>
</div>
</div>
</div>
</div>
</div>
<script>
  var hasToc = true;
  /*  var downloadable = /!*false*!/ false;
    var editable = /!*false*!/ false;
    var code = /!*"nginx"*!/ false;
    var version = /!*"current"*!/ false;
    var type = /!*"reference"*!/ false;
    var lang = /!*"zh"*!/ 'en';
    //edit link
    require(["gitbook", "jQuery"], function (gitbook, $) {
      gitbook.events.bind('start', function (e, config) {
        // Add edit toolbar to left
        var chapterId = /!*17692*!/ 0;
        if (downloadable) {
          gitbook.toolbar.createButton({
            icon: 'fa fa-download',
            text: '下载',
            onClick: function () {
              window.open('/download?code=' + code + '&version=' + version + '&type=' + type + '&lang=' + lang);
            }
          });
        }
        if (editable) {
          gitbook.toolbar.createButton({
            icon: 'fa fa-edit',
            text: '编辑此页',
            onClick: function () {
              window.open('/docs/edit?chapterId=' + chapterId + '&lang=' + lang);
            }
          });
        }
      });
    });*/
</script>
<script>
    var code = "nginx";
    var lang = "zh";
  </script>

<script src="static/js/autocomplete-js.js"></script>
<script src="static/js/app.min.js"></script>
<script src="static/js/search.min.js"></script>
</body>
</html>
